aiomysql API reference

52 public APIs from aiomysql (aio-libs/aiomysql) — 13 classes, 0 functions, 39 methods. Signatures extracted by static analysis of the actual source.

Repository: aio-libs/aiomysql

Kind	Count
Classes	13
Functions	0
Methods	39

API list

classaiomysql.connection.Connection

Representation of a socket with a mysql server.

methodaiomysql.connection.Connection.begin()

Begin transaction.

methodaiomysql.connection.Connection.close()

Close socket connection

methodaiomysql.connection.Connection.commit()

Commit changes to stable storage.

methodaiomysql.connection.Connection.db()

Current database name.

methodaiomysql.connection.Connection.echo()

Return echo mode status.

methodaiomysql.connection.Connection.encoding()

Encoding employed for this connection.

methodaiomysql.connection.Connection.escape(obj)

Escape whatever value you pass to it

methodaiomysql.connection.Connection.host()

MySQL server IP address or name

methodaiomysql.connection.Connection.literal(obj)

Alias for escape()

methodaiomysql.connection.Connection.ping(reconnect=True)

Check if the server is alive

methodaiomysql.connection.Connection.port()

MySQL server TCP/IP port

methodaiomysql.connection.Connection.rollback()

Roll back the current transaction.

methodaiomysql.connection.Connection.select_db(db)

Set current db

methodaiomysql.connection.Connection.show_warnings()

SHOW WARNINGS

methodaiomysql.connection.Connection.unix_socket()

MySQL Unix socket file location

methodaiomysql.connection.Connection.user()

User used while connecting to MySQL

classaiomysql.cursors.Cursor

Cursor is used to interact with the database.

methodaiomysql.cursors.Cursor.echo()

Return echo mode status.

methodaiomysql.cursors.Cursor.fetchone()

Fetch the next row

methodaiomysql.cursors.Cursor.nextset()

Get the next query set

methodaiomysql.cursors.Cursor.rownumber()

Row index.

methodaiomysql.cursors.Cursor.setinputsizes(*args)

Does nothing, required by DB API.

methodaiomysql.cursors.Cursor.setoutputsizes(*args)

Does nothing, required by DB API.

classaiomysql.cursors.DeserializationCursor

A cursor automatic deserialization of json type fields

classaiomysql.cursors.DictCursor

A cursor which returns results as a dictionary

classaiomysql.cursors.SSDictCursor

An unbuffered cursor, which returns results as a dictionary

classaiomysql.pool.Pool

Connection pool

methodaiomysql.pool.Pool.acquire()

Acquire free connection from the pool.

methodaiomysql.pool.Pool.clear()

Close all free connections in pool.

methodaiomysql.pool.Pool.close()

Close pool.

methodaiomysql.pool.Pool.terminate()

Terminate pool.

methodaiomysql.pool.Pool.wait_closed()

Wait for closing all pool's connections.

methodaiomysql.sa.engine.Engine.acquire()

Get a connection from pool.

methodaiomysql.sa.engine.Engine.close()

Close engine.

methodaiomysql.sa.engine.Engine.dialect()

An dialect for engine.

methodaiomysql.sa.engine.Engine.driver()

A driver of the dialect.

methodaiomysql.sa.engine.Engine.name()

A name of the dialect.

methodaiomysql.sa.engine.Engine.release(conn)

Revert back connection to pool.

methodaiomysql.sa.engine.Engine.terminate()

Terminate engine.

classaiomysql.sa.exc.ArgumentError

Raised when an invalid or conflicting function argument is supplied.

classaiomysql.sa.exc.Error

Generic error class.

classaiomysql.sa.exc.InvalidRequestError

aiomysql.sa was asked to do something it can't do.

classaiomysql.sa.exc.NoSuchColumnError

A nonexistent column is requested from a ``RowProxy``.

classaiomysql.sa.transaction.NestedTransaction

Represent a 'nested', or SAVEPOINT transaction.

classaiomysql.sa.transaction.Transaction

Represent a database transaction in progress.

methodaiomysql.sa.transaction.Transaction.close()

Close this transaction.

methodaiomysql.sa.transaction.Transaction.commit()

Commit this transaction.

methodaiomysql.sa.transaction.Transaction.rollback()

Roll back this transaction.

classaiomysql.sa.transaction.TwoPhaseTransaction

Represent a two-phase transaction.

methodaiomysql.sa.transaction.TwoPhaseTransaction.prepare()

Prepare this TwoPhaseTransaction.

methodaiomysql.sa.transaction.TwoPhaseTransaction.xid()

Returns twophase transaction id.

About this data

These signatures were extracted from the public source of aio-libs/aiomysql using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries