MySQLdb.connections.Connection

Package MySQLdb :: Module connections :: Class Connection

[show private | hide private]

Type Connection

object --+    
         |    
connection --+
             |
            Connection

MySQL Database Connection Object

Method Summary
	`__init__(self, args, *kwargs)` Create a connection to the database.
	`__enter__(self)`
	`__exit__(self, exc, value, tb)`
	`begin(self)` Explicitly begin a connection.
	`cursor(self, cursorclass)` Create a cursor on which queries may be performed.
	`errorhandler(connection, cursor, errorclass, errorvalue)` If cursor is not None, (errorclass, errorvalue) is appended to cursor.messages; otherwise it is appended to connection.messages.
	`literal(self, o)` If o is a single object, returns an SQL literal as a string.
	`set_character_set(self, charset)` Set the connection character set to charset.
	`set_sql_mode(self, sql_mode)` Set the connection sql_mode.
	`show_warnings(self)` Return detailed information about warnings as a sequence of tuples of (Level, Code, Message).
Inherited from connection
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__repr__(x)` x.__repr__() <==> repr(x)
	`affected_rows(...)` Return number of rows affected by the last query.
	`autocommit(...)` Set the autocommit mode.
	`change_user(...)` Changes the user and causes the database specified by db to become the default (current) database on the connection specified by mysql.
	`character_set_name(...)` Returns the default character set for the current connection.
	`close(...)` Close the connection.
	`commit(...)` Commits the current transaction
	`dump_debug_info(...)` Instructs the server to write some debug information to the log.
	`errno(...)` Returns the error code for the most recently invoked API function that can succeed or fail.
	`error(...)` Returns the error message for the most recently invoked API function that can succeed or fail.
	`escape(obj, dict)` using mapping dict to provide quoting functions for each type.
	`escape_string(s)` Use connection.escape_string(s), if you use it at all.
	`field_count(...)` Returns the number of columns for the most recent query on the connection.
	`get_character_set_info(...)` Returns a dict with information about the current character set:
	`get_host_info(...)` Returns a string that represents the MySQL client library version.
	`get_proto_info(...)` Returns an unsigned integer representing the protocol version used by the current connection.
	`get_server_info(...)` Returns a string that represents the server version number.
	`info(...)` Retrieves a string providing information about the most recently executed query.
	`insert_id(...)` Returns the ID generated for an AUTO_INCREMENT column by the previous query.
	`kill(...)` Asks the server to kill the thread specified by pid.
	`next_result(...)` If more query results exist, next_result() reads the next query results and returns the status back to application.
	`ping(...)` Checks whether or not the connection to the server is working.
	`query(...)` Execute a query.
	`rollback(...)` Rolls backs the current transaction
	`select_db(...)` Causes the database specified by db to become the default (current) database on the connection specified by mysql.
	`set_server_option(option)` for the connection.
	`shutdown(...)` Asks the database server to shut down.
	`sqlstate(...)` Returns a string containing the SQLSTATE error code for the last error.
	`stat(...)` Returns a character string containing information similar to that provided by the mysqladmin status command.
	`store_result(...)` Returns a result object acquired by mysql_store_result (results stored in the client).
	`string_literal(obj)` This means, any special SQL characters are escaped, and it is enclosed within single quotes.
	`thread_id(...)` Returns the thread ID of the current connection.
	`use_result(...)` Returns a result object acquired by mysql_use_result (results stored in the server).
	`warning_count(...)` Returns the number of warnings generated during execution of the previous SQL statement.
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Class Variable Summary
`type`	`default_cursor` = `MySQLdb.cursors.Cursor`
`classobj`	`DatabaseError` = `_mysql_exceptions.DatabaseError`
`classobj`	`DataError` = `_mysql_exceptions.DataError`
`classobj`	`Error` = `_mysql_exceptions.Error`
`classobj`	`IntegrityError` = `_mysql_exceptions.IntegrityError`
`classobj`	`InterfaceError` = `_mysql_exceptions.InterfaceError`
`classobj`	`InternalError` = `_mysql_exceptions.InternalError`
`classobj`	`NotSupportedError` = `_mysql_exceptions.NotSupportedError`
`classobj`	`OperationalError` = `_mysql_exceptions.OperationalError`
`classobj`	`ProgrammingError` = `_mysql_exceptions.ProgrammingError`
`classobj`	`Warning` = `_mysql_exceptions.Warning`
Inherited from connection
`member_descriptor`	`client_flag` = `<member 'client_flag' of '_mysql.connectio...`
`member_descriptor`	`converter` = `<member 'converter' of '_mysql.connection' o...`
`member_descriptor`	`open` = `<member 'open' of '_mysql.connection' objects>`
`member_descriptor`	`port` = `<member 'port' of '_mysql.connection' objects>`
`member_descriptor`	`server_capabilities` = `<member 'server_capabilities' of '...`

Method Details

init(self, *args, **kwargs)
(Constructor)

Create a connection to the database. It is strongly recommended that you only use keyword parameters. Consult the MySQL C API documentation for more information.

host: string, host to connect
user: string, user to connect as
passwd: string, password to use
db: string, database to use
port: integer, TCP/IP port to connect to
unix_socket: string, location of unix_socket to use
conv: conversion dictionary, see MySQLdb.converters
connect_timeout: number of seconds to wait before the connection attempt fails.
compress: if set, compression is enabled
named_pipe: if set, a named pipe is used to connect (Windows only)
init_command: command which is run once the connection is created
read_default_file: file from which default client values are read
read_default_group: configuration group to use from the default file
cursorclass: class object, used to create cursors (keyword only)
use_unicode: If True, text-like columns are returned as unicode objects using the connection's character set. Otherwise, text-like columns are returned as strings. columns are returned as normal strings. Unicode objects will always be encoded to the connection's character set regardless of this setting.
charset: If supplied, the connection character set will be changed to this character set (MySQL-4.1 and newer). This implies use_unicode=True.
sql_mode: If supplied, the session SQL mode will be changed to this setting (MySQL-4.1 and newer). For more details and legal values, see the MySQL documentation.
client_flag: integer, flags to use or 0 (see MySQL docs or constants/CLIENTS.py)
ssl: dictionary or mapping, contains SSL connection parameters; see the MySQL documentation for more details (mysql_ssl_set()). If this is set, and the client does not support SSL, NotSupportedError will be raised.
local_infile: integer, non-zero enables LOAD LOCAL INFILE; zero disables

There are a number of undocumented, non-standard methods. See the documentation for the MySQL C API for some hints on what they do.

Overrides:: _mysql.connection.__init__

begin(self)

Explicitly begin a connection. Non-standard. DEPRECATED: Will be removed in 1.3. Use an SQL BEGIN statement instead.

cursor(self, cursorclass=None)

Create a cursor on which queries may be performed. The optional cursorclass parameter is used to create the Cursor. By default, self.cursorclass=cursors.Cursor is used.

errorhandler(connection, cursor, errorclass, errorvalue)

If cursor is not None, (errorclass, errorvalue) is appended to cursor.messages; otherwise it is appended to connection.messages. Then errorclass is raised with errorvalue as the value.

You can override this with your own error handler by assigning it to the instance.

literal(self, o)

If o is a single object, returns an SQL literal as a string. If o is a non-string sequence, the items of the sequence are converted and returned as a sequence.

Non-standard. For internal use; do not use this in your applications.

set_character_set(self, charset)

Set the connection character set to charset. The character set can only be changed in MySQL-4.1 and newer. If you try to change the character set from the current value in an older version, NotSupportedError will be raised.

Overrides:: _mysql.connection.set_character_set

set_sql_mode(self, sql_mode)

Set the connection sql_mode. See MySQL documentation for legal values.

show_warnings(self)

Return detailed information about warnings as a sequence of tuples of (Level, Code, Message). This is only supported in MySQL-4.1 and up. If your server is an earlier version, an empty sequence is returned.

Generated by Epydoc 2.1 on Sat Mar 3 21:14:16 2007

http://epydoc.sf.net