Index of the sqlapi module
-
m
sqlapi
...
-
m
interfaces
...
-
C
IPlugin
...
-
a
module
...
-
a
movethread
...
-
a
threadsafety
...
-
a
auto_increment
...
-
a
pool
...
-
f
activate
...
- Called the first time this plugin is loaded. Will not be
called twice.
-
f
parse_uri
...
- Return a dictionary representation of the URI, as documented
in sqlapi.uri.parse_uri
-
f
guess_sequence_name
...
- Guess the name of the sequence for the given table and id name.
-
f
tables
...
- Return a list of table names, using the given cursor object
-
f
__init__
...
- Create an instance of the plugin, bound to connection
parameters and options.
-
f
sql_quote_symbol
...
- This is a generic implementation of quoting that applies to
tables and columns (if those methods are overridden).
-
f
sql_column_create
...
- Returns one line/column as you'd expect in a CREATE TABLE
statement. name is the column name. type is a
standard SQL string representing the type (e.g., 'INT').
params is a dictionary of arguments. default is the
caller's guess at the result.
-
f
activate_exceptions
...
- Called after activate(), and makes sure that the
exceptions raised by the database inherit from the exceptions
in sqlapi.exceptions
-
f
raw_connection
...
- Return the DB-API connection.
-
f
table_exists
...
- Does tablename exist in the database?
-
f
param_mark_generator
...
- Yield a sequence of (param_mark, param_name). If positional
parameters are used, then return None for param_name,
otherwise return a name used in a dictionary.
-
f
sql_literal
...
- This will only be called rendering the expression to string,
which shouldn't happen except for logging or debugging output
(it should not be sent to the database).
-
f
sql_postfix_operator
...
- Takes an operator (-like thing), like 'IS NULL'
-
f
get_sequence_nextval
...
- Get the next value for the named sequence
-
f
sql_operator
...
- This takes as an argument a string operator, which should be
the ANSI SQL operator. It then returns the operator to
actually be used.
-
f
sql_literal_param
...
- This can be used to convert a Python object to an object
that is accepted as a parameter by the database driver.
-
f
sql_table
...
- This returns a table name with any necessary quoting for a
database.
-
f
sql_function
...
- Takes a function name, like 'COUNT'
-
f
sql_unary_operator
...
- This takes a unary operator, like - meaning negation
-
f
sql_column
...
- This returns a column name with any necessary quoting for a
database.
-
m
uri
...
- Database URI parsing
-
f
parse_query_string
...
- Given a URI (or a fragment, as returned by parse_user_host)
return (uri_without_query_string, vars). vars is a
dictionary of variables in the query string (after ?). If
there are duplicate variables, they will show up as a list of
values.
-
f
int_or_none
...
-
f
asbool
...
-
f
load_plugin
...
-
f
parse_uri
...
- Parse a URI and return a dictionary representing the parse
results. This dictionary should have the following keys:
-
f
parse_user_host
...
- Remove the user and host information. Returns (user, password,
host, rest_of_uri). Expects to have remove_scheme() run
first.
-
f
remove_scheme
...
- Return the URI with the scheme removed.
-
m
util
...
-
m
connect
...
-
m
solid
...
- solid - hardened DB-API 2 connections.
-
m
threadpool
...
- Connection pool with thread affinity
-
m
wrapper
...
- A wrapper for DB-API connections, with SQL-API features
-
m
pool
...
- Connection pool.
-
m
sql
...
-
m
exceptions
...
- DB-API exceptions.
-
C
DataError
...
- Exception raised for errors that are due to problems with
the processed data like division by zero, numeric value
out of range, etc. It must be a subclass of DatabaseError.
-
C
InterfaceError
...
- Exception raised for errors that are related to the
database interface rather than the database itself. It
must be a subclass of Error.
-
C
InternalError
...
- Exception raised when the database encounters an internal
error, e.g. the cursor is not valid anymore, the
transaction is out of sync, etc. It must be a subclass of
DatabaseError.
-
C
IntegrityError
...
- Exception raised when the relational integrity of the
database is affected, e.g. a foreign key check fails. It
must be a subclass of DatabaseError.
-
C
Warning
...
- Exception raised for important warnings like data
truncations while inserting, etc. It must be a subclass of
the Python StandardError (defined in the module
exceptions).
-
C
OperationalError
...
- Exception raised for errors that are related to the
database's operation and not necessarily under the control
of the programmer, e.g. an unexpected disconnect occurs,
the data source name is not found, a transaction could not
be processed, a memory allocation error occurred during
processing, etc. It must be a subclass of DatabaseError.
-
C
Error
...
- Exception that is the base class of all other error
exceptions. You can use this to catch all errors with one
single 'except' statement. Warnings are not considered
errors and thus should not use this class as base. It must
be a subclass of the Python StandardError (defined in the
module exceptions).
-
C
ProgrammingError
...
- Exception raised for programming errors, e.g. table not
found or already exists, syntax error in the SQL
statement, wrong number of parameters specified, etc. It
must be a subclass of DatabaseError.
-
C
NotSupportedError
...
- Exception raised in case a method or database API was used
which is not supported by the database, e.g. requesting a
.rollback() on a connection that does not support
transaction or has transactions turned off. It must be a
subclass of DatabaseError.
-
C
DatabaseError
...
- Exception raised for errors that are related to the
database. It must be a subclass of Error.
-
f
install_exception_hierarchy
...
- This takes the given DB-API compliant module, and makes sure that
the exceptions inherit from the exceptions defined here.
-
m
backend
...
-
a
sqlite
...
-
m
generic
...
- This is a generic implementation of the plugin API, and a useful
abstract superclass for implementors.