mysql-connector-python API reference

400 public APIs from mysql-connector-python (mysql/mysql-connector-python) — 89 classes, 38 functions, 273 methods. Signatures extracted by static analysis of the actual source.

Repository: mysql/mysql-connector-python

Kind	Count
Classes	89
Functions	38
Methods	273

API list

funcautomation.headerfy.update_header(root:Union[str, Path], filename:str) -> None

Updates the Copyright header of the provided file.

classmysql-connector-python.cpydist.BaseCommand

Base command class for Connector/Python.

methodmysql-connector-python.cpydist.BaseCommand.finalize_options()

Finalize the options.

methodmysql-connector-python.cpydist.BaseCommand.initialize_options()

Initialize the options.

methodmysql-connector-python.cpydist.BaseCommand.remove_temp()

Remove temporary build files.

methodmysql-connector-python.cpydist.BuildExt.finalize_options()

Finalize the options.

methodmysql-connector-python.cpydist.BuildExt.initialize_options()

Initialize the options.

methodmysql-connector-python.cpydist.BuildExt.run()

Run the command.

classmysql-connector-python.cpydist.Install

Install Connector/Python implementation.

methodmysql-connector-python.cpydist.Install.finalize_options()

Finalize the options.

methodmysql-connector-python.cpydist.Install.initialize_options()

Initialize the options.

classmysql-connector-python.cpydist.InstallLib

InstallLib Connector/Python implementation.

methodmysql-connector-python.cpydist.InstallLib.finalize_options()

Finalize the options.

methodmysql-connector-python.cpydist.InstallLib.initialize_options()

Initialize the options.

methodmysql-connector-python.cpydist.InstallLib.run()

Run the command.

classmysql-connector-python.cpydist.bdist.DistBinary

Create a generic binary distribution.

methodmysql-connector-python.cpydist.bdist.DistBinary.finalize_options()

Finalize the options.

methodmysql-connector-python.cpydist.bdist.DistBinary.initialize_options()

Initialize the options.

methodmysql-connector-python.cpydist.bdist.DistBinary.run()

Run the command.

classmysql-connector-python.cpydist.bdist_wheel.DistWheel

Create a Wheel distribution.

methodmysql-connector-python.cpydist.bdist_wheel.DistWheel.finalize_options()

Finalize the options.

methodmysql-connector-python.cpydist.bdist_wheel.DistWheel.initialize_options()

Initialize the options.

methodmysql-connector-python.cpydist.bdist_wheel.DistWheel.run()

Run the command.

classmysql-connector-python.cpydist.sdist.DistSource

Create a generic source distribution.

methodmysql-connector-python.cpydist.sdist.DistSource.finalize_options()

Finalize the options.

methodmysql-connector-python.cpydist.sdist.DistSource.initialize_options()

Initialize the options.

methodmysql-connector-python.cpydist.sdist.DistSource.make_release_tree(base_dir, files)

Make the release tree.

methodmysql-connector-python.cpydist.sdist.DistSource.run()

Run the command.

funcmysql-connector-python.cpydist.utils.unarchive_targz(tarball)

Unarchive a tarball.

funcmysql-connector-python.cpydist.utils.write_info_bin(mysql_version=None, compiler=None)

Generate docs/INFO_BIN.

funcmysql-connector-python.cpydist.utils.write_info_src(version)

Generate docs/INFO_SRC.

classmysql-connector-python.lib.mysql.ai.genai.generation.MyLLM.Config

Pydantic config for the model.

classmysql-connector-python.lib.mysql.ai.ml.model.ML_TASK

Enumeration of supported ML tasks for HeatWave.

func

mysql-connector-python.lib.mysql.ai.utils.utils.is_table_empty(cursor:MySQLCursorAbstract, schema_name:str, table_name:str) -> bool

Determine if a given SQL table is empty.

funcmysql-connector-python.lib.mysql.connector._decorating.deprecated(reason:str) -> Callable

Use it to decorate deprecated methods.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.autocommit() -> bool

Gets whether autocommit is on or off.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.close() -> None

Disconnects from the MySQL server.

method

mysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.cmd_init_db(database:str) -> Optional[Dict[str, Any]]

Changes the current database.

method

mysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.cmd_process_kill(mysql_pid:int) -> Optional[Dict[str, Any]]

Kills a MySQL process.

method

mysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.cmd_shutdown(shutdown_type:Optional[int]=None) -> None

Shuts down the MySQL Server.

method

mysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.cmd_stmt_prepare(statement:bytes, **kwargs:Any) -> Union[Mapping[str, Any], CMySQLPrepStmt]

Prepares a MySQL statement.

method

mysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.cmd_stmt_send_long_data(statement_id:Union[int, CMySQLPrepStmt], param_id:int, data:BinaryIO, **kwargs:Any) -> int

Sends data for a column.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.commit() -> None

Commits current transaction.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.config(**kwargs:Any) -> None

Configures the MySQL Connection.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.connect(**kwargs:Any) -> None

Connects to the MySQL server.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.connection_id() -> Optional[int]

MySQL connection ID.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.database() -> str

The current database.

method

mysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.get_server_version() -> Optional[Tuple[int, ...]]

Gets the MySQL version.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.have_next_result() -> bool

Returns If have next result.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.info_query(query:str) -> Optional[RowType]

Sends a query which only returns 1 row.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.isset_client_flag(flag:int) -> bool

Checks if a client flag is set.

method

mysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.ping(reconnect:bool=False, attempts:int=1, delay:int=0) -> None

Checks availability of the MySQL server.

method

mysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.reconnect(attempts:int=1, delay:int=0) -> None

Attempts to reconnect to the MySQL server.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.rollback() -> None

Rollbacks current transaction.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.server_host() -> str

MySQL server IP address or name.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.server_port() -> int

MySQL server TCP/IP port.

method

mysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.set_client_flags(flags:Union[int, Sequence[int]]) -> int

Sets the client flags.

method

mysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.set_converter_class(convclass:Optional[Type[MySQLConverter]]) -> None

Sets the converter class to be used.

method

mysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.set_login(username:Optional[str]=None, password:Optional[str]=None) -> None

Sets login information for MySQL.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.shutdown() -> NoReturn

Shuts down connection to MySQL Server.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.sql_mode() -> str

Gets the SQL mode.

method

mysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.start_transaction(consistent_snapshot:bool=False, isolation_level:Optional[str]=None, readonly:Optional[bool]=None) -> None

Starts a transaction.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLConnectionAbstract.time_zone() -> str

Gets the current time zone.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLCursorAbstract.close() -> None

Close the cursor.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLCursorAbstract.reset(free:bool=True) -> None

Resets the cursor to default

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLCursorAbstract.setinputsizes(sizes:Any) -> NoReturn

Not Implemented.

method

mysql-connector-python.lib.mysql.connector.abstracts.MySQLCursorAbstract.setoutputsize(size:Any, column:Any=None) -> NoReturn

Not Implemented.

methodmysql-connector-python.lib.mysql.connector.abstracts.MySQLCursorAbstract.warning_count() -> int

Returns the number of warnings.

funcmysql-connector-python.lib.mysql.connector.aio._decorating.deprecated(reason:str) -> Callable

Use it to decorate deprecated methods.

classmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract

Defines the MySQL connection interface.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.add_cursor(cursor:MySQLCursorAbstract) -> None

Add cursor to the weakref set.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.close() -> None

Close the connection.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.cmd_debug() -> EofPacketType

Send the DEBUG command.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.cmd_init_db(database:str) -> OkPacketType

Change the current database.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.cmd_ping() -> OkPacketType

Send the PING command.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.cmd_process_kill(mysql_pid:int) -> OkPacketType

Kill a MySQL process.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.cmd_query(query:StrOrBytes, raw:bool=False, buffered:bool=False, raw_as_string:bool=False, **kwargs:Any) -> ResultType

Send a query to the MySQL server.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.cmd_shutdown(shutdown_type:Optional[int]=None) -> None

Shut down the MySQL Server.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.cmd_stmt_close(statement_id:int, **kwargs:Any) -> None

Deallocate a prepared MySQL statement.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.cmd_stmt_fetch(statement_id:int, rows:int=1, **kwargs:Any) -> None

Fetch a MySQL statement Result Set.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.cmd_stmt_prepare(statement:bytes, **kwargs:Any) -> Mapping[str, Union[int, List[DescriptionType]]]

Prepare a MySQL statement.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.cmd_stmt_send_long_data(statement_id:int, param_id:int, data:BinaryIO, **kwargs:Any) -> int

Send data for a column.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.commit() -> None

Commit current transaction.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.connect() -> None

Connect to the MySQL server.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.connection_id() -> Optional[int]

MySQL connection ID.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.consume_results() -> None

Consume pending results.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.database() -> str

Get the current database.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.get_database() -> str

Get the current database.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.get_self() -> MySQLConnectionAbstract

Return self for weakref.proxy.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.get_server_version() -> Optional[Tuple[int, ...]]

Gets the MySQL version.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.get_sql_mode() -> str

Gets the SQL mode.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.get_time_zone() -> str

Gets the current time zone.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.handle_unread_result() -> None

Handle unread result.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.have_next_result() -> bool

Return if have next result.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.info_query(query:StrOrBytes) -> Optional[RowType]

Send a query which only returns 1 row.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.isset_client_flag(flag:int) -> bool

Checks if a client flag is set.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.loop() -> asyncio.AbstractEventLoop

Return the event loop.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.ping(reconnect:bool=False, attempts:int=1, delay:int=0) -> bool

Check availability of the MySQL server.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.reconnect(attempts:int=1, delay:int=0) -> None

Attempts to reconnect to the MySQL server.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.remove_cursor(cursor:MySQLCursorAbstract) -> None

Remove cursor from the weakref set.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.rollback() -> None

Rollback current transaction.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.server_host() -> str

MySQL server IP address or name.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.server_port() -> int

MySQL server TCP/IP port.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.server_version() -> Optional[Tuple[int, ...]]

Gets the MySQL version.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.set_allow_local_infile_in_path(path:str) -> None

Set the path that user can upload files.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.set_autocommit(value:bool) -> None

Toggle autocommit.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.set_client_flags(flags:Union[int, Sequence[int]]) -> int

Set the client flags.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.set_converter_class(convclass:Optional[Type[MySQLConverter]]) -> None

Set the converter class to be used.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.set_database(value:str) -> None

Set the current database.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.set_sql_mode(value:Union[str, Sequence[int]]) -> None

Sets the SQL mode.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.set_time_zone(value:str) -> None

Sets the time zone.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.sql_mode() -> str

Gets the SQL mode.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.start_transaction(consistent_snapshot:bool=False, isolation_level:Optional[str]=None, readonly:Optional[bool]=None) -> None

Starts a transaction.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.time_zone() -> str

Gets the current time zone.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.unix_socket() -> Optional[str]

MySQL Unix socket file location.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLConnectionAbstract.user() -> str

User used while connecting to MySQL.

classmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLCursorAbstract

Defines the MySQL cursor interface.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLCursorAbstract.close() -> bool

Close the cursor.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLCursorAbstract.column_names() -> Tuple[str, ...]

Returns column names.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLCursorAbstract.fetchone() -> Optional[RowType]

Return next row of a query result set.

method

mysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLCursorAbstract.fetchwarnings() -> Optional[List[WarningType]]

Returns Warnings.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLCursorAbstract.reset(free:bool=True) -> Any

Reset the cursor to default.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLCursorAbstract.warning_count() -> int

Return the number of warnings.

methodmysql-connector-python.lib.mysql.connector.aio.abstracts.MySQLCursorAbstract.warnings() -> Optional[List[WarningType]]

Gets warnings.

classmysql-connector-python.lib.mysql.connector.aio.authentication.MySQLAuthenticator

Implements the authentication phase.

classmysql-connector-python.lib.mysql.connector.aio.charsets.Charset

Dataclass representing a character set.

methodmysql-connector-python.lib.mysql.connector.aio.connection.MySQLConnection.cmd_debug() -> EofPacketType

Send the DEBUG command.

methodmysql-connector-python.lib.mysql.connector.aio.connection.MySQLConnection.cmd_init_db(database:str) -> OkPacketType

Change the current database.

methodmysql-connector-python.lib.mysql.connector.aio.connection.MySQLConnection.cmd_ping() -> OkPacketType

Send the PING command.

method

mysql-connector-python.lib.mysql.connector.aio.connection.MySQLConnection.cmd_process_kill(mysql_pid:int) -> OkPacketType

Kill a MySQL process.

method

mysql-connector-python.lib.mysql.connector.aio.connection.MySQLConnection.cmd_shutdown(shutdown_type:Optional[int]=None) -> None

Shut down the MySQL Server.

method

mysql-connector-python.lib.mysql.connector.aio.connection.MySQLConnection.cmd_stmt_close(statement_id:int, **kwargs:Any) -> None

Deallocate a prepared MySQL statement.

method

mysql-connector-python.lib.mysql.connector.aio.connection.MySQLConnection.cmd_stmt_fetch(statement_id:int, rows:int=1, **kwargs:Any) -> None

Fetch a MySQL statement Result Set.

method

mysql-connector-python.lib.mysql.connector.aio.connection.MySQLConnection.cmd_stmt_prepare(statement:bytes, **kwargs:Any) -> Mapping[str, Union[int, List[DescriptionType]]]

Prepare a MySQL statement.

method

mysql-connector-python.lib.mysql.connector.aio.connection.MySQLConnection.cmd_stmt_send_long_data(statement_id:int, param_id:int, data:BinaryIO, **kwargs:Any) -> int

Send data for a column.

methodmysql-connector-python.lib.mysql.connector.aio.connection.MySQLConnection.commit() -> None

Commit current transaction.

methodmysql-connector-python.lib.mysql.connector.aio.connection.MySQLConnection.connection_id() -> Optional[int]

MySQL connection ID.

method

mysql-connector-python.lib.mysql.connector.aio.connection.MySQLConnection.ping(reconnect:bool=False, attempts:int=1, delay:int=0) -> None

Check availability of the MySQL server.

methodmysql-connector-python.lib.mysql.connector.aio.connection.MySQLConnection.rollback() -> None

Rollback current transaction.

methodmysql-connector-python.lib.mysql.connector.aio.connection.MySQLConnection.shutdown() -> None

Shut down connection to MySQL Server.

classmysql-connector-python.lib.mysql.connector.aio.cursor.MySQLCursor

Default cursor for interacting with MySQL.

methodmysql-connector-python.lib.mysql.connector.aio.cursor.MySQLCursor.fetchall() -> List[RowType]

Return all rows of a query result set.

funcmysql-connector-python.lib.mysql.connector.aio.cursor.MySQLCursor.remove_comments(match:re.Match) -> str

Remove comments from INSERT statements.

classmysql-connector-python.lib.mysql.connector.aio.cursor.MySQLCursorBuffered

Cursor which fetches rows within execute().

methodmysql-connector-python.lib.mysql.connector.aio.cursor.MySQLCursorBuffered.reset(free:bool=True) -> None

Reset the cursor to default.

classmysql-connector-python.lib.mysql.connector.aio.cursor.MySQLCursorDict

Cursor fetching rows as dictionaries.

classmysql-connector-python.lib.mysql.connector.aio.cursor.MySQLCursorPrepared

Cursor using MySQL Prepared Statements

funcmysql-connector-python.lib.mysql.connector.aio.cursor.replace(matchobj:re.Match) -> bytes

Replace pattern.

classmysql-connector-python.lib.mysql.connector.aio.network.MySQLSocket

MySQL socket communication interface.

methodmysql-connector-python.lib.mysql.connector.aio.network.MySQLSocket.address() -> str

Socket location.

methodmysql-connector-python.lib.mysql.connector.aio.network.MySQLSocket.close_connection() -> None

Close the connection.

methodmysql-connector-python.lib.mysql.connector.aio.network.MySQLSocket.is_connected() -> bool

Check if the socket is connected.

methodmysql-connector-python.lib.mysql.connector.aio.network.MySQLSocket.open_connection(**kwargs:Any) -> None

Open the socket.

methodmysql-connector-python.lib.mysql.connector.aio.network.MySQLSocket.read(read_timeout:Optional[int]=None) -> bytearray

Read packets from the MySQL server.

methodmysql-connector-python.lib.mysql.connector.aio.network.MySQLSocket.set_connection_timeout(timeout:int) -> None

Set the connection timeout.

classmysql-connector-python.lib.mysql.connector.aio.network.MySQLTcpSocket

MySQL socket class using TCP/IP.

methodmysql-connector-python.lib.mysql.connector.aio.network.MySQLTcpSocket.open_connection(**kwargs:Any) -> None

Open TCP/IP connection.

classmysql-connector-python.lib.mysql.connector.aio.network.MySQLUnixSocket

MySQL socket class using UNIX sockets.

methodmysql-connector-python.lib.mysql.connector.aio.network.MySQLUnixSocket.open_connection(**kwargs:Any) -> None

Open UNIX socket connection.

classmysql-connector-python.lib.mysql.connector.aio.network.NetworkBroker

Broker class interface.

method

mysql-connector-python.lib.mysql.connector.aio.network.NetworkBroker.write(writer:StreamWriter, address:str, payload:bytes, packet_number:Optional[int]=None, compressed_packet_number:Optional[int]=None, write_timeout:Optional[int]=None) -> None

Send `payload` to the MySQL server.

classmysql-connector-python.lib.mysql.connector.aio.network.NetworkBrokerPlain

Broker class for MySQL socket communication.

methodmysql-connector-python.lib.mysql.connector.aio.network.NetworkBrokerPlain.get_header(pkt:bytes) -> Tuple[int, int]

Recover the header information from a packet.

classmysql-connector-python.lib.mysql.connector.aio.plugins.MySQLAuthPlugin

Authorization plugin interface.

method

mysql-connector-python.lib.mysql.connector.aio.plugins.MySQLAuthPlugin.auth_response(auth_data:bytes, **kwargs:Any) -> Optional[bytes]

Make the client's authorization response.

methodmysql-connector-python.lib.mysql.connector.aio.plugins.MySQLAuthPlugin.name() -> str

Plugin official name.

methodmysql-connector-python.lib.mysql.connector.aio.plugins.MySQLAuthPlugin.ssl_enabled() -> bool

Signals whether or not SSL is enabled.

classmysql-connector-python.lib.mysql.connector.aio.pooling.MySQLConnectionPool

Class defining a pool of MySQL connections

method

mysql-connector-python.lib.mysql.connector.aio.pooling.MySQLConnectionPool.add_connection(cnx:Optional[MySQLConnectionAbstract]=None) -> None

Adds a connection to the pool.

methodmysql-connector-python.lib.mysql.connector.aio.pooling.MySQLConnectionPool.can_reset_session() -> bool

Returns whether to reset session.

func

mysql-connector-python.lib.mysql.connector.aio.pooling.connect(*args:Any, **kwargs:Any) -> Union[PooledMySQLConnection, MySQLConnectionAbstract]

Creates a MySQL connection object.

classmysql-connector-python.lib.mysql.connector.aio.protocol.MySQLProtocol

Implements MySQL client/server protocol.

classmysql-connector-python.lib.mysql.connector.authentication.MySQLAuthenticator

Implements the authentication phase.

classmysql-connector-python.lib.mysql.connector.connection.MySQLConnection

Connection to a MySQL Server

methodmysql-connector-python.lib.mysql.connector.connection.MySQLConnection.commit() -> None

Commit current transaction

methodmysql-connector-python.lib.mysql.connector.connection.MySQLConnection.connection_id() -> Optional[int]

MySQL connection ID

methodmysql-connector-python.lib.mysql.connector.connection.MySQLConnection.consume_results() -> None

Consume results

methodmysql-connector-python.lib.mysql.connector.connection.MySQLConnection.database() -> str

Get the current database

methodmysql-connector-python.lib.mysql.connector.connection.MySQLConnection.info_query(query:str) -> Optional[RowType]

Send a query which only returns 1 row

methodmysql-connector-python.lib.mysql.connector.connection.MySQLConnection.rollback() -> None

Rollback current transaction

methodmysql-connector-python.lib.mysql.connector.connection.MySQLConnection.set_allow_local_infile_in_path(path:str) -> None

Set the path that user can upload files.

methodmysql-connector-python.lib.mysql.connector.connection.MySQLConnection.shutdown() -> None

Shut down connection to MySQL Server.

classmysql-connector-python.lib.mysql.connector.constants.ClientFlag

MySQL Client Flags.

classmysql-connector-python.lib.mysql.connector.constants.FieldType

MySQL Field Types.

methodmysql-connector-python.lib.mysql.connector.constants.FieldType.get_binary_types() -> List[int]

Get the list of all binary types

methodmysql-connector-python.lib.mysql.connector.constants.FieldType.get_number_types() -> List[int]

Get the list of all number types

methodmysql-connector-python.lib.mysql.connector.constants.FieldType.get_string_types() -> List[int]

Get the list of all string types

methodmysql-connector-python.lib.mysql.connector.constants.FieldType.get_timestamp_types() -> List[int]

Get the list of all timestamp types

classmysql-connector-python.lib.mysql.connector.constants.RefreshOption

MySQL Refresh command options.

classmysql-connector-python.lib.mysql.connector.constants.RefreshOptionMeta

RefreshOption Metaclass.

classmysql-connector-python.lib.mysql.connector.constants.ServerCmd

MySQL Server Commands

classmysql-connector-python.lib.mysql.connector.constants.ServerCmdMeta

ClientFlag Metaclass.

funcmysql-connector-python.lib.mysql.connector.constants.flag_is_set(flag:int, flags:int) -> bool

Checks if the flag is set Returns boolean

methodmysql-connector-python.lib.mysql.connector.cursor.MySQLCursor.fetchall() -> List[RowType]

Return all rows of a query result set.

methodmysql-connector-python.lib.mysql.connector.cursor.MySQLCursor.fetchone() -> Optional[RowType]

Return next row of a query result set.

funcmysql-connector-python.lib.mysql.connector.cursor.MySQLCursor.remove_comments(match:re.Match) -> str

Remove comments from INSERT statements.

classmysql-connector-python.lib.mysql.connector.cursor.MySQLCursorBuffered

Cursor which fetches rows within execute()

classmysql-connector-python.lib.mysql.connector.cursor.MySQLCursorDict

Cursor fetching rows as dictionaries.

classmysql-connector-python.lib.mysql.connector.cursor.MySQLCursorPrepared

Cursor using MySQL Prepared Statements

funcmysql-connector-python.lib.mysql.connector.cursor.replace(matchobj:re.Match) -> bytes

Replace pattern.

funcmysql-connector-python.lib.mysql.connector.cursor_cext.CMySQLCursor.remove_comments(match:re.Match) -> str

Remove comments from INSERT statements.

classmysql-connector-python.lib.mysql.connector.cursor_cext.CMySQLCursorBuffered

Cursor using C Extension buffering results

classmysql-connector-python.lib.mysql.connector.cursor_cext.CMySQLCursorPrepared

Cursor using MySQL Prepared Statements

methodmysql-connector-python.lib.mysql.connector.cursor_cext.CMySQLCursorPrepared.reset(free:bool=True) -> None

Resets the prepared statement.

classmysql-connector-python.lib.mysql.connector.cursor_cext.CMySQLCursorRaw

Cursor using C Extension return raw results

classmysql-connector-python.lib.mysql.connector.custom_types.HexLiteral

Class holding MySQL hex literals

classmysql-connector-python.lib.mysql.connector.django.base.DatabaseWrapper

Represent a database connection.

methodmysql-connector-python.lib.mysql.connector.django.base.DatabaseWrapper.display_name() -> str

Display name.

methodmysql-connector-python.lib.mysql.connector.django.base.DatabaseWrapper.mysql_server_data() -> Dict[str, Any]

Return MySQL server data.

methodmysql-connector-python.lib.mysql.connector.django.base.DatabaseWrapper.mysql_server_info() -> Any

Return MySQL version.

methodmysql-connector-python.lib.mysql.connector.django.base.DatabaseWrapper.mysql_version() -> Tuple[int, ...]

Return MySQL version.

methodmysql-connector-python.lib.mysql.connector.django.base.DatabaseWrapper.sql_mode() -> Set[str]

Return SQL mode.

classmysql-connector-python.lib.mysql.connector.django.base.DjangoMySQLConverter

Custom converter for Django.

classmysql-connector-python.lib.mysql.connector.django.features.DatabaseFeatures

Database Features Specification class.

classmysql-connector-python.lib.mysql.connector.django.operations.DatabaseOperations

Database Operations class.

method

mysql-connector-python.lib.mysql.connector.django.operations.DatabaseOperations.value_to_db_datetime(value:Optional[datetime]) -> Optional[bytes]

Convert value to MySQL DATETIME.

method

mysql-connector-python.lib.mysql.connector.django.operations.DatabaseOperations.value_to_db_time(value:Optional[time]) -> Optional[bytes]

Convert value to MySQL TIME.

classmysql-connector-python.lib.mysql.connector.errors.DatabaseError

Exception for errors related to the database

classmysql-connector-python.lib.mysql.connector.errors.Error

Exception that is base class for all other error exceptions.

classmysql-connector-python.lib.mysql.connector.errors.InterfaceError

Exception for errors related to the interface

classmysql-connector-python.lib.mysql.connector.errors.InternalError

Exception for errors internal database errors

classmysql-connector-python.lib.mysql.connector.errors.OperationalError

Exception for errors related to the database's operation

classmysql-connector-python.lib.mysql.connector.errors.PoolError

Exception for errors relating to connection pooling

classmysql-connector-python.lib.mysql.connector.errors.ProgrammingError

Exception for errors programming errors

classmysql-connector-python.lib.mysql.connector.errors.Warning

Exception for important warnings

classmysql-connector-python.lib.mysql.connector.network.MySQLSocket

MySQL socket communication interface.

methodmysql-connector-python.lib.mysql.connector.network.MySQLSocket.address() -> str

Get the location of the socket.

methodmysql-connector-python.lib.mysql.connector.network.MySQLSocket.close_connection() -> None

Close the socket.

methodmysql-connector-python.lib.mysql.connector.network.MySQLSocket.open_connection() -> None

Open the socket.

methodmysql-connector-python.lib.mysql.connector.network.MySQLSocket.recv(read_timeout:Optional[int]=None) -> bytearray

Get packet from the MySQL server comm channel.

methodmysql-connector-python.lib.mysql.connector.network.MySQLSocket.set_connection_timeout(timeout:Optional[int]) -> None

Set the connection timeout.

methodmysql-connector-python.lib.mysql.connector.network.MySQLSocket.shutdown() -> None

Shut down the socket before closing it.

methodmysql-connector-python.lib.mysql.connector.network.MySQLSocket.switch_to_ssl(ssl_context:Any, host:str) -> None

Upgrade an existing connection to TLS.

classmysql-connector-python.lib.mysql.connector.network.MySQLTCPSocket

MySQL socket class using TCP/IP.

classmysql-connector-python.lib.mysql.connector.network.MySQLUnixSocket

MySQL socket class using UNIX sockets.

methodmysql-connector-python.lib.mysql.connector.network.MySQLUnixSocket.switch_to_ssl(*args:Any, **kwargs:Any) -> None

Switch the socket to use SSL.

classmysql-connector-python.lib.mysql.connector.network.NetworkBroker

Broker class interface.

methodmysql-connector-python.lib.mysql.connector.network.NetworkBroker.recv(sock:socket.socket, address:str) -> bytearray

Get the next available packet from the MySQL server.

classmysql-connector-python.lib.mysql.connector.network.NetworkBrokerPlain

Broker class for MySQL socket communication.

methodmysql-connector-python.lib.mysql.connector.network.NetworkBrokerPlain.recv(sock:socket.socket, address:str) -> bytearray

Receive `one` packet from the MySQL server.

func

mysql-connector-python.lib.mysql.connector.opentelemetry.context_propagation.with_context_propagation(method:Callable) -> Callable

Perform trace context propagation.

func

mysql-connector-python.lib.mysql.connector.opentelemetry.context_propagation.wrapper(cnx:'MySQLConnectionAbstract', *args:Any, **kwargs:Any) -> Any

Context propagation decorator.

funcmysql-connector-python.lib.mysql.connector.opentelemetry.instrumentation.end_span(span:trace.Span) -> None

Ends span.

funcmysql-connector-python.lib.mysql.connector.opentelemetry.instrumentation.get_operation_name(operation:str) -> str

Parse query to extract operation name.

func

mysql-connector-python.lib.mysql.connector.opentelemetry.instrumentation.record_exception_event(span:trace.Span, exc:Optional[Exception]) -> None

Records an exeception event.

func

mysql-connector-python.lib.mysql.connector.opentelemetry.instrumentation.wrapper(cnx:'MySQLConnectionAbstract', *args:Any, **kwargs:Any) -> Any

Connection span attacher decorator.

func

mysql-connector-python.lib.mysql.connector.optionfiles.read_option_files(**config:Union[str, List[str]]) -> Dict[str, Any]

Read option files for connection parameters.

classmysql-connector-python.lib.mysql.connector.plugins.MySQLAuthPlugin

Authorization plugin interface.

method

mysql-connector-python.lib.mysql.connector.plugins.MySQLAuthPlugin.auth_response(auth_data:bytes, **kwargs:Any) -> Optional[bytes]

Make the client's authorization response.

methodmysql-connector-python.lib.mysql.connector.plugins.MySQLAuthPlugin.name() -> str

Plugin official name.

methodmysql-connector-python.lib.mysql.connector.plugins.MySQLAuthPlugin.requires_ssl() -> bool

Signals whether or not SSL is required.

methodmysql-connector-python.lib.mysql.connector.plugins.MySQLAuthPlugin.ssl_enabled() -> bool

Signals whether or not SSL is enabled.

classmysql-connector-python.lib.mysql.connector.pooling.MySQLConnectionPool

Class defining a pool of MySQL connections

method

mysql-connector-python.lib.mysql.connector.pooling.MySQLConnectionPool.add_connection(cnx:Optional[MySQLConnectionAbstract]=None) -> None

Adds a connection to the pool.

methodmysql-connector-python.lib.mysql.connector.pooling.MySQLConnectionPool.get_connection() -> PooledMySQLConnection

Gets a connection from the pool.

methodmysql-connector-python.lib.mysql.connector.pooling.MySQLConnectionPool.reset_session() -> bool

Returns whether to reset session.

func

mysql-connector-python.lib.mysql.connector.pooling.connect(*args:Any, **kwargs:Any) -> Union[PooledMySQLConnection, MySQLConnectionAbstract]

Creates or gets a MySQL connection object.

method

mysql-connector-python.lib.mysql.connector.protocol.MySQLProtocol.make_command(command:int, argument:Optional[bytes]=None) -> bytes

Make a MySQL packet containing a command

methodmysql-connector-python.lib.mysql.connector.protocol.MySQLProtocol.make_conn_attrs(conn_attrs:Dict[str, str]) -> bytes

Encode the connection attributes.

methodmysql-connector-python.lib.mysql.connector.protocol.MySQLProtocol.parse_auth_more_data(pkt:bytes) -> bytes

Parse a MySQL auth more data packet.

methodmysql-connector-python.lib.mysql.connector.protocol.MySQLProtocol.parse_auth_next_factor(pkt:bytes) -> Tuple[str, bytes]

Parse a MySQL auth next factor packet.

method

mysql-connector-python.lib.mysql.connector.protocol.MySQLProtocol.parse_auth_switch_request(pkt:bytes) -> Tuple[str, bytes]

Parse a MySQL auth switch request packet.

method

mysql-connector-python.lib.mysql.connector.protocol.MySQLProtocol.parse_binary_prepare_ok(packet:bytes) -> Dict[str, int]

Parse a MySQL Binary Protocol OK packet.

method

mysql-connector-python.lib.mysql.connector.protocol.MySQLProtocol.parse_column(packet:bytes, encoding:str='utf-8') -> DescriptionType

Parse a MySQL column-packet.

methodmysql-connector-python.lib.mysql.connector.protocol.MySQLProtocol.parse_eof(packet:bytes) -> EofPacketType

Parse a MySQL EOF-packet

methodmysql-connector-python.lib.mysql.connector.protocol.MySQLProtocol.parse_handshake(packet:bytes) -> HandShakeType

Parse a MySQL Handshake-packet.

methodmysql-connector-python.lib.mysql.connector.protocol.MySQLProtocol.parse_ok(packet:bytes) -> OkPacketType

Parse a MySQL OK-packet

method

mysql-connector-python.lib.mysql.connector.protocol.MySQLProtocol.parse_statistics(packet:bytes, with_header:bool=True) -> StatsPacketType

Parse the statistics packet

classmysql-connector-python.lib.mysql.connector.types.MySQLScriptPartition

Represents a partition or sub-script.

funcmysql-connector-python.lib.mysql.connector.utils.import_object(fullpath:str) -> Any

Import an object from a fully qualified module path.

func

mysql-connector-python.lib.mysql.connector.utils.init_bytearray(payload:Union[int, StrOrBytes]=b'', encoding:str='utf-8') -> bytearray

Initialize a bytearray from the payload.

funcmysql-connector-python.lib.mysql.connector.utils.int8store(i:int) -> bytes

Takes an unsigned integer (8 bytes) and packs it as string.

funcmysql-connector-python.lib.mysql.connector.utils.intread(buf:Union[int, bytes]) -> int

Unpacks the given buffer to an integer

funcmysql-connector-python.lib.mysql.connector.utils.intstore(i:int) -> bytes

Takes an unsigned integers and packs it as a bytes-object.

funcmysql-connector-python.lib.mysql.connector.utils.read_bytes(buf:bytes, size:int) -> Tuple[bytes, bytes]

Reads bytes from a buffer.

funcmysql-connector-python.support.django.run_django_tests.main()

Start application

classmysql-connector-python.unittests.BasicTestResult

Basic test result

methodmysql-connector-python.unittests.BasicTestResult.addSkip(test, reason)

Save skipped reasons

classmysql-connector-python.unittests.BasicTestRunner

Basic test runner

classmysql-connector-python.unittests.StatsTestResult

Store test results in a database

classmysql-connector-python.unittests.StatsTestRunner

Committing results test results

funcmysql-connector-python.unittests.init_mysql_server(port, options)

Initialize a MySQL Server

funcmysql-connector-python.unittests.warnings_filter(record)

Filter out warnings.

classmysqlx-connector-python.cpydist.BaseCommand

Base command class for Connector/Python.

methodmysqlx-connector-python.cpydist.BaseCommand.finalize_options()

Finalize the options.

methodmysqlx-connector-python.cpydist.BaseCommand.initialize_options()

Initialize the options.

methodmysqlx-connector-python.cpydist.BaseCommand.remove_temp()

Remove temporary build files.

methodmysqlx-connector-python.cpydist.BuildExt.finalize_options()

Finalize the options.

methodmysqlx-connector-python.cpydist.BuildExt.initialize_options()

Initialize the options.

methodmysqlx-connector-python.cpydist.BuildExt.run()

Run the command.

classmysqlx-connector-python.cpydist.Install

Install Connector/Python implementation.

methodmysqlx-connector-python.cpydist.Install.finalize_options()

Finalize the options.

methodmysqlx-connector-python.cpydist.Install.initialize_options()

Initialize the options.

classmysqlx-connector-python.cpydist.InstallLib

InstallLib Connector/Python implementation.

methodmysqlx-connector-python.cpydist.InstallLib.finalize_options()

Finalize the options.

methodmysqlx-connector-python.cpydist.InstallLib.initialize_options()

Initialize the options.

methodmysqlx-connector-python.cpydist.InstallLib.run()

Run the command.

classmysqlx-connector-python.cpydist.bdist.DistBinary

Create a generic binary distribution.

methodmysqlx-connector-python.cpydist.bdist.DistBinary.finalize_options()

Finalize the options.

methodmysqlx-connector-python.cpydist.bdist.DistBinary.initialize_options()

Initialize the options.

methodmysqlx-connector-python.cpydist.bdist.DistBinary.run()

Run the command.

classmysqlx-connector-python.cpydist.bdist_wheel.DistWheel

Create a Wheel distribution.

methodmysqlx-connector-python.cpydist.bdist_wheel.DistWheel.finalize_options()

Finalize the options.

methodmysqlx-connector-python.cpydist.bdist_wheel.DistWheel.run()

Run the command.

classmysqlx-connector-python.cpydist.sdist.DistSource

Create a generic source distribution.

methodmysqlx-connector-python.cpydist.sdist.DistSource.finalize_options()

Finalize the options.

methodmysqlx-connector-python.cpydist.sdist.DistSource.initialize_options()

Initialize the options.

methodmysqlx-connector-python.cpydist.sdist.DistSource.run()

Run the command.

funcmysqlx-connector-python.cpydist.utils.unarchive_targz(tarball)

Unarchive a tarball.

funcmysqlx-connector-python.cpydist.utils.write_info_bin(mysql_version=None, compiler=None)

Generate docs/INFO_BIN.

funcmysqlx-connector-python.cpydist.utils.write_info_src(version)

Generate docs/INFO_SRC.

methodmysqlx-connector-python.lib.mysqlx.connection.Client.close() -> None

Closes the sessions opened by this client.

classmysqlx-connector-python.lib.mysqlx.connection.Connection

Connection to a MySQL Server.

methodmysqlx-connector-python.lib.mysqlx.connection.Connection.close_result(result:Result) -> None

Close result.

methodmysqlx-connector-python.lib.mysqlx.connection.Connection.close_session() -> None

Close a sucessfully authenticated session.

methodmysqlx-connector-python.lib.mysqlx.connection.Connection.connect() -> None

Attempt to connect to the MySQL server.

methodmysqlx-connector-python.lib.mysqlx.connection.Connection.disconnect() -> None

Disconnect from server.

method

mysqlx-connector-python.lib.mysqlx.connection.Connection.execute_nonquery(namespace:str, cmd:str, raise_on_fail:bool, fields:Optional[Dict[str, Any]]=None) -> Optional[Result]

Execute a non query command.

methodmysqlx-connector-python.lib.mysqlx.connection.Connection.execute_sql_scalar(sql:StatementType) -> int

Execute a SQL scalar.

methodmysqlx-connector-python.lib.mysqlx.connection.Connection.fetch_active_result() -> None

Fetch active result.

methodmysqlx-connector-python.lib.mysqlx.connection.Connection.get_column_metadata(result:Result) -> List[ColumnType]

Get column metadata.

methodmysqlx-connector-python.lib.mysqlx.connection.Connection.get_next_statement_id() -> int

Returns the next statement ID.

methodmysqlx-connector-python.lib.mysqlx.connection.Connection.get_row_result(cmd:str, fields:Dict[str, Any]) -> RowResult

Returns the row result.

methodmysqlx-connector-python.lib.mysqlx.connection.Connection.is_open() -> bool

Check if connection is open.

methodmysqlx-connector-python.lib.mysqlx.connection.Connection.read_row(result:RowResult) -> Optional[MessageType]

Read row.

methodmysqlx-connector-python.lib.mysqlx.connection.Connection.reset_session() -> None

Reset a sucessfully authenticated session.

method

mysqlx-connector-python.lib.mysqlx.connection.Connection.send_delete(statement:Union[DeleteStatement, RemoveStatement]) -> Result

Send an delete statement.

method

mysqlx-connector-python.lib.mysqlx.connection.Connection.send_find(statement:Union[FindStatement, SelectStatement]) -> Union[DocResult, RowResult]

Send an find statement.

method

mysqlx-connector-python.lib.mysqlx.connection.Connection.send_insert(statement:Union[AddStatement, InsertStatement]) -> Result

Send an insert statement.

methodmysqlx-connector-python.lib.mysqlx.connection.Connection.send_sql(statement:SqlStatement) -> SqlResult

Execute a SQL statement.

method

mysqlx-connector-python.lib.mysqlx.connection.Connection.send_update(statement:Union[ModifyStatement, UpdateStatement]) -> Result

Send an delete statement.

methodmysqlx-connector-python.lib.mysqlx.connection.Connection.set_active_result(result:ResultBaseType) -> None

Set active result.

classmysqlx-connector-python.lib.mysqlx.connection.ConnectionPool

This class represents a pool of connections.

methodmysqlx-connector-python.lib.mysqlx.connection.ConnectionPool.add_connection(cnx:Optional[PooledConnection]=None) -> None

Adds a connection to this pool.

methodmysqlx-connector-python.lib.mysqlx.connection.ConnectionPool.close() -> None

Empty this ConnectionPool.

method

mysqlx-connector-python.lib.mysqlx.connection.ConnectionPool.remove_connection(cnx:Optional[PooledConnection]=None) -> None

Removes a connection from this pool.

methodmysqlx-connector-python.lib.mysqlx.connection.ConnectionPool.remove_connections() -> None

Removes all the connections from the pool.

methodmysqlx-connector-python.lib.mysqlx.connection.PooledConnection.close_connection() -> None

Closes the connection.

methodmysqlx-connector-python.lib.mysqlx.connection.PooledConnection.reconnect() -> None

Reconnect this connection.

methodmysqlx-connector-python.lib.mysqlx.connection.PooledConnection.reset() -> None

Reset the connection.

classmysqlx-connector-python.lib.mysqlx.connection.Router

Represents a set of connection parameters.

methodmysqlx-connector-python.lib.mysqlx.connection.Session.close() -> None

Closes the session.

methodmysqlx-connector-python.lib.mysqlx.connection.Session.drop_schema(name:str) -> None

Drops the schema with the specified name.

methodmysqlx-connector-python.lib.mysqlx.connection.Session.get_connection() -> Connection

Returns the underlying connection.

methodmysqlx-connector-python.lib.mysqlx.connection.Session.is_open() -> bool

Returns `True` if the session is open.

methodmysqlx-connector-python.lib.mysqlx.connection.Session.release_savepoint(name:str) -> None

Release a transaction savepoint with the given name.

methodmysqlx-connector-python.lib.mysqlx.connection.Session.rollback_to(name:str) -> None

Rollback to a transaction savepoint with the given name.

methodmysqlx-connector-python.lib.mysqlx.connection.Session.set_savepoint(name:Optional[str]=None) -> str

Creates a transaction savepoint.

classmysqlx-connector-python.lib.mysqlx.connection.SocketStream

Implements a socket stream.

methodmysqlx-connector-python.lib.mysqlx.connection.SocketStream.close() -> None

Close the socket.

method

mysqlx-connector-python.lib.mysqlx.connection.SocketStream.connect(params:Tuple, connect_timeout:float=_CONNECT_TIMEOUT) -> None

Connects to a TCP service.

methodmysqlx-connector-python.lib.mysqlx.connection.SocketStream.is_open() -> bool

Verifies if connection is open.

methodmysqlx-connector-python.lib.mysqlx.connection.SocketStream.is_secure() -> bool

Verifies if connection is secure.

methodmysqlx-connector-python.lib.mysqlx.connection.SocketStream.is_ssl() -> bool

Verifies if SSL is being used.

methodmysqlx-connector-python.lib.mysqlx.connection.SocketStream.read(count:int) -> bytes

Receive data from the socket.

methodmysqlx-connector-python.lib.mysqlx.connection.SocketStream.sendall(data:bytes) -> None

Send data to the socket.

method

mysqlx-connector-python.lib.mysqlx.connection.SocketStream.set_ssl(ssl_protos:List[str], ssl_mode:str, ssl_ca:str, ssl_crl:str, ssl_cert:str, ssl_key:str, ssl_ciphers:List[str]) -> None

Set SSL parameters.

funcmysqlx-connector-python.lib.mysqlx.connection.catch_network_exception(func:Callable) -> Callable

Decorator used to catch OSError or RuntimeError.

funcmysqlx-connector-python.lib.mysqlx.connection.generate_pool_name(**kwargs:Any) -> str

Generate a pool name.

funcmysqlx-connector-python.lib.mysqlx.connection.update_timeout_penalties_by_error(penalty_dict:Mapping[str, Any]) -> None

Update the timeout penalties directory.

funcmysqlx-connector-python.lib.mysqlx.connection.wrapper(self:Any, *args:Any, **kwargs:Any) -> Any

Wrapper function.

classmysqlx-connector-python.lib.mysqlx.constants.Auth

Enum to identify the authentication mechanisms.

classmysqlx-connector-python.lib.mysqlx.constants.Compression

Enum to identify the compression options.

classmysqlx-connector-python.lib.mysqlx.constants.LockContention

Enum to identify the row locking modes.

classmysqlx-connector-python.lib.mysqlx.constants.SSLMode

Enum to identify the SSL modes.

classmysqlx-connector-python.lib.mysqlx.crud.Collection

Represents a collection of documents on a schema.

methodmysqlx-connector-python.lib.mysqlx.crud.Collection.add(*values:DbDoc) -> AddStatement

Adds a list of documents to a collection.

methodmysqlx-connector-python.lib.mysqlx.crud.Collection.count() -> int

Counts the documents in the collection.

method

mysqlx-connector-python.lib.mysqlx.crud.Collection.create_index(index_name:str, fields_desc:Dict[str, Any]) -> CreateCollectionIndexStatement

Creates a collection index.

methodmysqlx-connector-python.lib.mysqlx.crud.Collection.drop_index(index_name:str) -> None

Drops a collection index.

methodmysqlx-connector-python.lib.mysqlx.crud.Collection.find(condition:Optional[str]=None) -> FindStatement

Retrieves documents from a collection.

methodmysqlx-connector-python.lib.mysqlx.crud.Collection.get_one(doc_id:str) -> DbDoc

Returns a Document matching the Document ID.

methodmysqlx-connector-python.lib.mysqlx.crud.Collection.modify(condition:str) -> ModifyStatement

Modifies documents based on the ``condition``.

methodmysqlx-connector-python.lib.mysqlx.crud.Collection.remove(condition:str) -> RemoveStatement

Removes documents based on the ``condition``.

methodmysqlx-connector-python.lib.mysqlx.crud.Collection.remove_one(doc_id:str) -> 'Result'

Removes a Document matching the Document ID.

classmysqlx-connector-python.lib.mysqlx.crud.DatabaseObject

Provides base functionality for database objects.

methodmysqlx-connector-python.lib.mysqlx.crud.DatabaseObject.get_connection() -> ConnectionType

Returns the underlying connection.

methodmysqlx-connector-python.lib.mysqlx.crud.DatabaseObject.get_name() -> str

Returns the name of this database object.

methodmysqlx-connector-python.lib.mysqlx.crud.DatabaseObject.name() -> str

str: The name of this database object.

methodmysqlx-connector-python.lib.mysqlx.crud.DatabaseObject.schema() -> SchemaType

:class:`mysqlx.Schema`: The Schema object.

methodmysqlx-connector-python.lib.mysqlx.crud.DatabaseObject.who_am_i() -> str

Returns the name of this database object.

classmysqlx-connector-python.lib.mysqlx.crud.Schema

A client-side representation of a database schema.

methodmysqlx-connector-python.lib.mysqlx.crud.Schema.drop_collection(name:str) -> None

Drops a collection.

methodmysqlx-connector-python.lib.mysqlx.crud.Schema.get_table(name:str, check_existence:bool=False) -> Table

Returns the table of the given name for this schema.

methodmysqlx-connector-python.lib.mysqlx.crud.Schema.get_tables() -> List[Table]

Returns a list of tables for this schema.

methodmysqlx-connector-python.lib.mysqlx.crud.Schema.get_view(name:str, check_existence:bool=False) -> View

Returns the view of the given name for this schema.

classmysqlx-connector-python.lib.mysqlx.crud.Table

Represents a database table on a schema.

methodmysqlx-connector-python.lib.mysqlx.crud.Table.count() -> int

Counts the rows in the table.

methodmysqlx-connector-python.lib.mysqlx.crud.Table.insert(*fields:Any) -> InsertStatement

Creates a new :class:`mysqlx.InsertStatement` object.

methodmysqlx-connector-python.lib.mysqlx.crud.Table.select(*fields:str) -> SelectStatement

Creates a new :class:`mysqlx.SelectStatement` object.

methodmysqlx-connector-python.lib.mysqlx.crud.Table.update() -> UpdateStatement

Creates a new :class:`mysqlx.UpdateStatement` object.

classmysqlx-connector-python.lib.mysqlx.crud.View

Represents a database view on a schema.

classmysqlx-connector-python.lib.mysqlx.dbdoc.DbDoc

Represents a generic document in JSON format.

methodmysqlx-connector-python.lib.mysqlx.dbdoc.DbDoc.keys() -> KeysView[str]

Returns the keys.

classmysqlx-connector-python.lib.mysqlx.errors.DatabaseError

Exception for errors related to the database.

classmysqlx-connector-python.lib.mysqlx.errors.Error

Exception that is base class for all other error exceptions.

classmysqlx-connector-python.lib.mysqlx.errors.InterfaceError

Exception for errors related to the interface.

classmysqlx-connector-python.lib.mysqlx.errors.InternalError

Exception for errors internal database errors.

classmysqlx-connector-python.lib.mysqlx.errors.PoolError

Exception for errors relating to connection pooling.

classmysqlx-connector-python.lib.mysqlx.errors.ProgrammingError

Exception for errors programming errors.

About this data

These signatures were extracted from the public source of mysql/mysql-connector-python 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