API Reference

Connect

aql.connect(location, *args, **kwargs)

Connect to the specified database.

Parameters

  • location (Union[str, aql.types.Location]) –

  • args (Any) –

  • kwargs (Any) –

Return type

aql.engines.base.Connection

Tables

class aql.column.Column(name, ctype=None, default=<object object>, table_name='')

Bases: object

Parameters

  • name (str) –

  • ctype (Type) –

  • default (Any) –

  • table_name (str) –

Return type

None

ilike(value)
Parameters

value (str) –

Return type

aql.types.Comparison

in_(values)
Parameters

values (Sequence[Any]) –

Return type

aql.types.Comparison

like(value)
Parameters

value (str) –

Return type

aql.types.Comparison

property full_name: str
class aql.table.Table(name, cons, source=None)

Bases: Generic[aql.table.T]

Table specification using custom columns and a source type.

create(if_not_exists=False)

Shortcut for Query(<table>).create()

Parameters

if_not_exists (bool) –

Return type

aql.query.Query

delete()

Shortcut for Query(<table>).delete()

Return type

aql.query.Query

insert(*columns)

Shortcut for Query(<table>).insert()

Parameters

columns (aql.column.Column) –

Return type

aql.query.Query

select(*columns)

Shortcut for Query(<table>).select()

Parameters

columns (aql.column.Column) –

Return type

aql.query.Query

update(*comps, **values)

Shortcut for Query(<table>).update()

Parameters

  • comps (aql.types.Comparison) –

  • values (Any) –

Return type

aql.query.Query

Errors

exception aql.AqlError

Bases: Exception

exception aql.BuildError

Bases: aql.errors.AqlError

exception aql.QueryError

Bases: aql.errors.AqlError

Advanced

class aql.engines.base.Engine

Bases: object

prepare(query)

Given a query, generate the full SQL query and all parameters.

Default behavior is to call the method on the engine class corresponding to the query action.

Parameters

query (aql.query.Query[aql.engines.base.T]) –

Return type

aql.query.PreparedQuery[aql.engines.base.T]

class aql.engines.base.Connection(engine, location, *args, **kwargs)

Bases: object

Parameters
async abort()

Rollback/cancel the current transaction.

Return type

None

async begin()

Begin a new transaction.

Return type

None

async close()

Close the connection.

Return type

None

async commit()

Commit the current transaction.

Return type

None

async connect()

Initiate the connection.

Return type

None

async cursor()

Return a new cursor object.

Return type

aql.engines.base.Cursor

execute(query)

Execute the given query on a new cursor and return the cursor.

Parameters

query (aql.query.Query[aql.engines.base.T]) –

Return type

aql.engines.base.Result[aql.engines.base.T]

classmethod get_connector(name)

Given a name, get a connector class.

Parameters

name (str) –

Return type

Tuple[Type[aql.engines.base.Connection], Type[aql.engines.base.Engine]]

query(query)

Execute the given query on a new cursor and return the cursor.

Parameters

query (aql.query.Query[aql.engines.base.T]) –

Return type

aql.engines.base.Result[aql.engines.base.T]

async rollback()

Rollback/cancel the current transaction.

Return type

None

property autocommit: bool
class aql.engines.base.Cursor(connection, cursor)

Bases: object

Parameters
async close()

Close the cursor.

Return type

None

convert(row)

Convert from the cursor’s native data type to the query object type.

Return type

aql.engines.base.T

async execute(query, parameters=None)

Execute the given query with this cursor.

Parameters

  • query (str) –

  • parameters (Optional[Any]) –

Return type

None

async fetchall()

Return all rows from the previous query.

Return type

Sequence[Any]

async fetchone()

Return the next row from the previous query, or None when exhausted.

Return type

Optional[Any]

async query(query, parameters=None)

Execute the given query with this cursor.

Parameters

  • query (str) –

  • parameters (Optional[Any]) –

Return type

None

property connection: aql.engines.base.Connection

Return the associated connection object.

property last_id: Optional[int]

ID of last modified row, or None if not available.

property row_count: int

Number of rows affected by previous query.

class aql.engines.base.Result(query, connection)

Bases: Generic[aql.engines.base.T]

Lazy awaitable or async-iterable object that runs the query once awaited.

Awaiting the result object will fetch and convert all rows to appropriate objects. Iterating the result will fetch and convert individual rows at a time.

Examples:

result = db.execute(Foo.select())
# query not yet executed
rows = await result
# query executed and any resulting rows returned
print(result.row_count)

async for row in db.execute(Foo.select()):
    ...

rows = await db.execute(Foo.select())
async row()
Return type

Optional[aql.engines.base.T]

async rows()
Return type

Sequence[aql.engines.base.T]

async run()
Return type

aql.engines.base.Cursor

property last_id: Optional[int]

ID of last modified row, or None if not available.

property row_count: int

Number of rows affected by previous query.