What is pyAttachSQL?¶

pyAttachSQL is a lightweight, high performance, asynchronous library for Python applications designed to connect to MySQL servers. It is a wrapper for the C client library libAttachSQL.

It is Apache 2.0 licensed so that it is possible to use both with Open Source and Commercial applications. It is also designed to provided a relatively easy to use API.

Licensing¶

Documentation Content¶

The pyAttachSQL Documentation is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

                              Apache License
                        Version 2.0, January 2004
                     http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

   "License" shall mean the terms and conditions for use, reproduction,
   and distribution as defined by Sections 1 through 9 of this document.

   "Licensor" shall mean the copyright owner or entity authorized by
   the copyright owner that is granting the License.

   "Legal Entity" shall mean the union of the acting entity and all
   other entities that control, are controlled by, or are under common
   control with that entity. For the purposes of this definition,
   "control" means (i) the power, direct or indirect, to cause the
   direction or management of such entity, whether by contract or
   otherwise, or (ii) ownership of fifty percent (50%) or more of the
   outstanding shares, or (iii) beneficial ownership of such entity.

   "You" (or "Your") shall mean an individual or Legal Entity
   exercising permissions granted by this License.

   "Source" form shall mean the preferred form for making modifications,
   including but not limited to software source code, documentation
   source, and configuration files.

   "Object" form shall mean any form resulting from mechanical
   transformation or translation of a Source form, including but
   not limited to compiled object code, generated documentation,
   and conversions to other media types.

   "Work" shall mean the work of authorship, whether in Source or
   Object form, made available under the License, as indicated by a
   copyright notice that is included in or attached to the work
   (an example is provided in the Appendix below).

   "Derivative Works" shall mean any work, whether in Source or Object
   form, that is based on (or derived from) the Work and for which the
   editorial revisions, annotations, elaborations, or other modifications
   represent, as a whole, an original work of authorship. For the purposes
   of this License, Derivative Works shall not include works that remain
   separable from, or merely link (or bind by name) to the interfaces of,
   the Work and Derivative Works thereof.

   "Contribution" shall mean any work of authorship, including
   the original version of the Work and any modifications or additions
   to that Work or Derivative Works thereof, that is intentionally
   submitted to Licensor for inclusion in the Work by the copyright owner
   or by an individual or Legal Entity authorized to submit on behalf of
   the copyright owner. For the purposes of this definition, "submitted"
   means any form of electronic, verbal, or written communication sent
   to the Licensor or its representatives, including but not limited to
   communication on electronic mailing lists, source code control systems,
   and issue tracking systems that are managed by, or on behalf of, the
   Licensor for the purpose of discussing and improving the Work, but
   excluding communication that is conspicuously marked or otherwise
   designated in writing by the copyright owner as "Not a Contribution."

   "Contributor" shall mean Licensor and any individual or Legal Entity
   on behalf of whom a Contribution has been received by Licensor and
   subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   copyright license to reproduce, prepare Derivative Works of,
   publicly display, publicly perform, sublicense, and distribute the
   Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
   this License, each Contributor hereby grants to You a perpetual,
   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
   (except as stated in this section) patent license to make, have made,
   use, offer to sell, sell, import, and otherwise transfer the Work,
   where such license applies only to those patent claims licensable
   by such Contributor that are necessarily infringed by their
   Contribution(s) alone or by combination of their Contribution(s)
   with the Work to which such Contribution(s) was submitted. If You
   institute patent litigation against any entity (including a
   cross-claim or counterclaim in a lawsuit) alleging that the Work
   or a Contribution incorporated within the Work constitutes direct
   or contributory patent infringement, then any patent licenses
   granted to You under this License for that Work shall terminate
   as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
   Work or Derivative Works thereof in any medium, with or without
   modifications, and in Source or Object form, provided that You
   meet the following conditions:

   (a) You must give any other recipients of the Work or
       Derivative Works a copy of this License; and

   (b) You must cause any modified files to carry prominent notices
       stating that You changed the files; and

   (c) You must retain, in the Source form of any Derivative Works
       that You distribute, all copyright, patent, trademark, and
       attribution notices from the Source form of the Work,
       excluding those notices that do not pertain to any part of
       the Derivative Works; and

   (d) If the Work includes a "NOTICE" text file as part of its
       distribution, then any Derivative Works that You distribute must
       include a readable copy of the attribution notices contained
       within such NOTICE file, excluding those notices that do not
       pertain to any part of the Derivative Works, in at least one
       of the following places: within a NOTICE text file distributed
       as part of the Derivative Works; within the Source form or
       documentation, if provided along with the Derivative Works; or,
       within a display generated by the Derivative Works, if and
       wherever such third-party notices normally appear. The contents
       of the NOTICE file are for informational purposes only and
       do not modify the License. You may add Your own attribution
       notices within Derivative Works that You distribute, alongside
       or as an addendum to the NOTICE text from the Work, provided
       that such additional attribution notices cannot be construed
       as modifying the License.

   You may add Your own copyright statement to Your modifications and
   may provide additional or different license terms and conditions
   for use, reproduction, or distribution of Your modifications, or
   for any such Derivative Works as a whole, provided Your use,
   reproduction, and distribution of the Work otherwise complies with
   the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
   any Contribution intentionally submitted for inclusion in the Work
   by You to the Licensor shall be under the terms and conditions of
   this License, without any additional terms or conditions.
   Notwithstanding the above, nothing herein shall supersede or modify
   the terms of any separate license agreement you may have executed
   with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
   names, trademarks, service marks, or product names of the Licensor,
   except as required for reasonable and customary use in describing the
   origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
   agreed to in writing, Licensor provides the Work (and each
   Contributor provides its Contributions) on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
   implied, including, without limitation, any warranties or conditions
   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
   PARTICULAR PURPOSE. You are solely responsible for determining the
   appropriateness of using or redistributing the Work and assume any
   risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
   whether in tort (including negligence), contract, or otherwise,
   unless required by applicable law (such as deliberate and grossly
   negligent acts) or agreed to in writing, shall any Contributor be
   liable to You for damages, including any direct, indirect, special,
   incidental, or consequential damages of any character arising as a
   result of this License or out of the use or inability to use the
   Work (including but not limited to damages for loss of goodwill,
   work stoppage, computer failure or malfunction, or any and all
   other commercial damages or losses), even if such Contributor
   has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
   the Work or Derivative Works thereof, You may choose to offer,
   and charge a fee for, acceptance of support, warranty, indemnity,
   or other liability obligations and/or rights consistent with this
   License. However, in accepting such obligations, You may act only
   on Your own behalf and on Your sole responsibility, not on behalf
   of any other Contributor, and only if You agree to indemnify,
   defend, and hold each Contributor harmless for any liability
   incurred by, or claims asserted against, such Contributor by reason
   of your accepting any such warranty or additional liability.

Installing¶

python setup.py install

pyAttachSQL Module Basics¶

Connection Class¶

class attachsql.connection(hostname, user, password, database, port)¶

Parameters:	hostname (str) – The hostname to the server user (str) – The user name to connect with password (str) – The password to connect with database (str) – The default database for the connection port (int) – The port to connect on or 0 for a Unix Domain Socket connection

connection_id()¶

Returns the connection ID of the connection. If there is no established connection this will return 0.

Returns:	The ID for the connection
Return type:	int

connect()¶

Start connection to the server. poll() needs to be called (usually more than once) for the connection to actually occur.

Returns:	True on success
Return type:	bool

poll()¶

Poll a connection to see if there is more data.

Returns:	A numeric status to be compared with Return Constants
Return type:	int

get_server_version()¶

Returns the version string for the server

Returns:	The version string
Return type:	str

query(query[, parameters])¶

Send a query to the server. Parameters can be given to fill in ? markers in a query. This should be in a Python list containing dictionaries formatted as follows as follows:

[{'type': attachsql.ESCAPE_TYPE_CHAR, 'data':'hello'}, {'type': attachsql.ESCAPE_TYPE_INT, 'data': 123456, is_unsigned: True}]

For a full list of types see Escape Constants

Parameters:	query (str) – The query statement to send parameters (list) –
Returns:	A query class
Return type:	query

set_ssl(key, cert, ca, capath, cipher[, verify])¶

Sets the SSL certifications and enables SSL connections

Parameters:	key (str) – The path for the key file cert (str) – The path for the certificate ca (str) – The path for the CA capath (str) – The path containing many CAs cipher (str) – A list of ciphers to allow verify (bool) – Set to verify the SSL connection
Returns:	True on success
Return type:	boolean

set_option(option[, unused])¶

Sets a connection option, the list of possible options can be found in Option Constants

Parameters:	option (int) – The option to set unused – This parameter is for future use
Returns:	True on success
Return type:	boolean

prepare_statement(statement)¶

Initialize and start sending a prepared statement

Parameters:	statement (str) – The statement to send
Returns:	An instance of statement
Return type:	statement

Group Class¶

class attachsql.group(callback_function, callback_context)¶

Creates a group of connections to execute statements in the same event loop. In this mode events trigger callbacks instead of the normal polling so a callback function is required.

Parameters:	callback_function (object) – The function name to use for the callback callback_context (object) – An object of arbitrary data to send to the callback function

create_connection(hostname, user, password, database, port)¶

Creates a new connection in the connection group and returns the connection object. The connection itself is not made at this time.

Parameters:	hostname (str) – The hostname to the server user (str) – The user name to connect with password (str) – The password to connect with port (int) – The port to connect on or 0 for a Unix Domain Socket connection
Returns:	A connection class which is attached to this group
Return type:	connection

run()¶

Runs a single iteration of the event loop. If an event is triggered the py:function:my_callback will be fired before this returns.

Returns:	None

Query Class¶

class attachsql.query¶

column_count()¶

Returns the number of columns in a query result

Returns:	The number of columns
Return type:	int

row_get()¶

Returns a Python tuple containing strings of the row data for the current row

Returns:	The row data
Return type:	tuple

row_next()¶

Start retrieval of the next row

Returns:	None

last_insert_id()¶

Returns the last insert ID from the previous query

Returns:	The insert ID
Return type:	long

affected_rows()¶

Returns the number of affected rows from the previous query

Returns:	The number of affected rows
Return type:	long

warning_count()¶

Returns the number of warnings generated by the last query

Returns:	The warning count
Return type:	long

info()¶

Returns the info from the last query

Returns:	The query info
Return type:	str

row_count()¶

Returns the row count for a buffered query

Returns:	The row count
Return type:	long

next_result()¶

Start retrieval of the next result set in a multi statement / result query

Returns:	RETURN_PROCESSING for more results, RETURN_EOF for no more results
Return type:	int

buffer_rows()¶

Enable row buffering for connection

Returns:	True on success
Return type:	bool

buffer_row_get()¶

Return the next row from a buffered result set in a similar way to row_get()

Returns:	The row data
Return type:	tuple

row_get_offset(offset)¶

Return a specific row from a buffered result set in a similar way to row_get()

Parameters:	offset (long) – The offset row
Returns:	The row data
Return type:	tuple

Prepared Statement Class¶

class attachsql.statement¶

execute()¶

Start execution a prepared statement

Returns:	True on success
Return type:	boolean

reset()¶

Reset a prepared statement

Returns:	True on success
Return type:	boolean

send_long_data(param_no, data)¶

Send a long data packet as a server parameter

Parameters:	param_no (int) – The parameter to set (starting from 0) data (str) – The data to set
Returns:	True on success
Return type:	boolean

param_count()¶

The number of parameters in the query to be set

Returns:	The number of parameters
Return type:	int

set_int(param_no, data[, is_unsigned])¶

Sets a parameter as an integer

Parameters:	param_no (int) – The parameter to set (starting from 0) data (int) – The data to set is_unsigned (boolean) – Whether or not the data is unsigned (False by default)
Returns:	True on success
Return type:	boolean

set_bigint(param_no, data[, is_unsigned])¶

Sets a parameter as a bigint

Parameters:	param_no (int) – The parameter to set (starting from 0) data (longlong) – The data to set is_unsigned (boolean) – Whether or not the data is unsigned (False by default)
Returns:	True on success
Return type:	boolean

set_float(param_no, data)¶

Sets a double precision floating point number

Parameters:	param_no (int) – The parameter to set (starting from 0) data (float) – The data to set
Returns:	True on success
Return type:	boolean

set_string(param_no, data)¶

Sets a string parameter

Parameters:	param_no (int) – The parameter to set (starting from 0) data (str) – The data to set
Returns:	True on success
Return type:	boolean

set_null(param_no)¶

Sets a parameter to NULL

Parameters:	param_no (int) – The parameter to set (starting from 0)
Returns:	True on success
Return type:	boolean

set_datetime(param_no, data)¶

Sets a parameter to a datetime.datetime or datetime.date object

Parameters:	param_no (int) – The parameter to set (starting from 0) data (datetime) – The date / datetime to set
Returns:	True on success
Return type:	boolean

set_time(param_no, data)¶

Sets a parameter to a datetime.time object

Parameters:	param_no (int) – The parameter to set (starting from 0) data (time) – The time to set
Returns:	True on success
Return type:	boolean

row_get()¶

Retrieve a ready row from the buffer

Returns:	True on success
Return type:	boolean

get_int(column_no[, get_unsigned])¶

Get an int from the row

Parameters:	column_no (int) – The column number to get (starting from 0) get_unsigned (boolean) – Whether or not to get the data as unsigned (False by default)
Returns:	The integer data
Return type:	long

get_bigint(column_no[, get_unsigned])¶

Get a bigint from the row

Parameters:	column_no (int) – The column number to get (starting from 0) get_unsigned (boolean) – Whether or not to get the data as unsigned (False by default)
Returns:	The bigint data
Return type:	longlong

get_float(column_no)¶

Get a float from the row

Parameters:	column_no (int) – The column number to get (starting from 0)
Returns:	The float data
Return type:	float

get_char(column_no)¶

Get a character string from the row

Parameters:	column_no (int) – The column number to get (starting from 0)
Returns:	The char data
Return type:	str

get_column_type(column_no)¶

Get the native column type for a column, types are to be compared with Column Type Constants

Parameters:	column_no (int) – The column number to get (starting from 0)
Returns:	The column type
Return type:	int

row_next()¶

Start retrieving the next row of the results

Returns:	None

get_column_count()¶

Get the number of columns in the results

Returns:	The number of columns
Return type:	int

DB API Module Basics¶

DB API Connection Class¶

class attachdb.Connection(host, port=3306, user='', password='', database='', autocommit=False)¶

Parameters:	host (str) – The hostname to the server or path to Unix Domain Socket port (int) – The port number for the server or 0 for Unix Domain Socket user (str) – The username for the server password (str) – The password for the server database (str) – The default database for the connection autocommit (bool) – Enable/disable autocommit (None for server default)

autocommit(setting)¶

Enables/disables autocommit for the connection

Parameters:	setting (bool) – True to enable, False to disable

commit()¶

Commit a transaction

rollback()¶

Roll back a transaction

close()¶

Close the connection

cursor()¶

Create a new cursor for the connection to execute queries

Returns:	The new cursor
Return type:	Cursor

DB API Cursor Class¶

class attachdb.Cursor¶

arraysize¶

An integer representing the number of rows to be returned by fetchmany() if not specified by the function call. Defaults to 1

callproc(name, parameters=None)¶

Call a stored procedure

Parameters:	name (str) – the name of the stored procedure parameters (tuple) – parameters for the stored procedure

close()¶

Close the cursor. This will read through to the end of the result set first if there is one active

execute(query, parameters=[])¶

Execute a query with optional prepared statement style parameters. Parameter markers should be question marks (?).

Parameters:	query (str) – the query to execute parameters (list) – parameters for the query

executemany(operation, sequence)¶

Execute a query multiple times with each of a sequences of parameters. For use with INSERT or UPDATE queries.

Parameters:	operation (str) – the query to execute sequence (list) – a list containing lists of parameters

fetchone()¶

Fetch the next result from the result set. Returns None if there are now rows left.

Returns:	The next row in the result set (or None)
Return type:	tuple

fetchmany(size=None)¶

Fetch many rows from a result set. The maximum amount to return is set by the size parameter or arraysize if this is not set.

Parameters:	size (int) – the amount of rows to return
Returns:	a list of row tuples
Return type:	list

fetchall()¶

Fetch all the rows in a result set.

Returns:	a list of row tuples
Return type:	list

nextset()¶

Start receiving the next result set in a multiple result set query

Returns:	True if successful, None is there is no more result sets
Return type:	boolean

setinputsizes(sizes)¶

Not implemented

setoutputsizes(size, column=None)¶

Not implemented