Privex Python Database Wrappers
latest
Main:
Privex Python Database Wrappers (privex-db) documentation
Installing Privex Python DB Wrappers
Download and install from PyPi using pipenv / pip (recommended)
(Alternative) Manual install from Git
Examples / Basic Usage
Using the SQLite3 Manager + Query Builder
Basic / direct usage of SqliteWrapper
Using the query builder (SqliteQueryBuilder)
Sub-classing SqliteWrapper for your app
Using the query builder from your sub-class
Code Documentation:
privex.db.base
CursorManager
Methods
__init__
close
execute
fetchall
fetchmany
fetchone
Attributes
description
lastrowid
rowcount
DBExecution
Methods
Attributes
GenericDBWrapper
Methods
__init__
action
close_cursor
create_schema
create_schemas
drop_schemas
drop_table
drop_tables
fetch
fetchall
fetchone
get_cursor
list_tables
make_connection
query
recreate_schemas
table_exists
Attributes
AUTO_ZIP_COLS
DEFAULT_ENABLE_EXECUTION_LOG
DEFAULT_QUERY_MODE
DEFAULT_TABLE_LIST_QUERY
DEFAULT_TABLE_QUERY
SCHEMAS
conn
cursor
tables_created
privex.db.postgres
PostgresWrapper
Methods
__init__
builder
drop_table
last_insert_id
list_tables
query
table_exists
Attributes
AUTO_ZIP_COLS
DEFAULT_DB
DEFAULT_QUERY_MODE
DEFAULT_TABLE_LIST_QUERY
DEFAULT_TABLE_QUERY
conn
cursor_cls
cursor_map
privex.db.sqlite
SqliteWrapper
Methods
__init__
builder
Attributes
DEFAULT_DB
DEFAULT_DB_FOLDER
DEFAULT_DB_NAME
DEFAULT_TABLE_LIST_QUERY
DEFAULT_TABLE_QUERY
conn
privex.db.types
GenericConnection
Methods
__init__
close
commit
cursor
rollback
GenericCursor
Methods
__init__
close
execute
executemany
fetchall
fetchmany
fetchone
privex.db.query
privex.db.query.base
BaseQueryBuilder
Methods
__init__
all
build_query
close_cursor
execute
fetch
fetch_next
get_cursor
group_by
limit
order
order_by
select
where
where_or
Attributes
Q_DEFAULT_PLACEHOLDER
Q_GROUP_BY_CLAUSE
Q_LIMIT_CLAUSE
Q_OFFSET_CLAUSE
Q_ORDER_CLAUSE
Q_POST_QUERY
Q_PRE_QUERY
Q_SELECT_CLAUSE
Q_WHERE_CLAUSE
connection
cursor
QueryMode
Attributes
DEFAULT
ROW_DICT
ROW_TUPLE
privex.db.query.postgres
PostgresQueryBuilder
Methods
__init__
all
build_query
fetch
fetch_next
get_cursor
query_mode_cursor
select_date
Attributes
Q_DEFAULT_PLACEHOLDER
Q_PRE_QUERY
conn
cursor
privex.db.query.sqlite
SqliteQueryBuilder
Methods
all
build_query
fetch
fetch_next
Attributes
Q_DEFAULT_PLACEHOLDER
Q_PRE_QUERY
conn
connection
Unit Testing
How to use the unit tests
Testing pre-requisites
Running via PyTest
Running individual test modules
Unit Test List / Overview
tests.base
ExampleWrapper
Methods
__init__
Attributes
DEFAULT_DB
SCHEMAS
PrivexDBTestBase
Methods
setUp
tearDown
Attributes
User
Methods
Attributes
tests.test_postgres
BasePostgresTest
Methods
setUp
setUpClass
tearDown
Attributes
conn
ExamplePostgresWrapper
Methods
__init__
find_user
insert_user
Attributes
DEFAULT_DB
SCHEMAS
TestPostgresBuilder
Methods
test_all_call
test_generator_builder
test_group_call
test_index_builder
test_iterate_builder
test_query_all
test_query_select_col_where
test_query_select_col_where_group
test_query_select_col_where_order
test_query_where_first_name_last_name
test_where_call
Attributes
pytestmark
TestPostgresWrapper
Methods
test_action_update
test_find_user_dict_mode
test_find_user_nonexistent
test_get_users_dict
test_get_users_tuple
test_insert_find_user
test_tables_created
test_tables_drop
Attributes
pytestmark
tests.test_sqlite_builder
TestSQLiteBuilder
Methods
test_all_call
test_generator_builder
test_group_call
test_index_builder
test_iterate_builder
test_query_all
test_query_select_col_where
test_query_select_col_where_group
test_query_select_col_where_order
test_query_where_first_name_last_name
test_where_call
Attributes
tests.test_sqlite_wrapper
TestSQLiteWrapper
Methods
test_action_update
test_find_user_dict_mode
test_find_user_nonexistent
test_get_users_dict
test_get_users_tuple
test_insert_find_user
test_tables_created
test_tables_drop
Attributes
Privex Python Database Wrappers
Docs
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
L
|
M
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
_
__init__() (privex.db.base.CursorManager method)
(privex.db.base.GenericDBWrapper method)
(privex.db.postgres.PostgresWrapper method)
(privex.db.query.base.BaseQueryBuilder method)
(privex.db.query.postgres.PostgresQueryBuilder method)
(privex.db.sqlite.SqliteWrapper method)
(privex.db.types.GenericConnection method)
(privex.db.types.GenericCursor method)
(tests.base.ExampleWrapper method)
(tests.test_postgres.ExamplePostgresWrapper method)
A
action() (privex.db.base.GenericDBWrapper method)
,
[1]
,
[2]
all() (privex.db.query.base.BaseQueryBuilder method)
,
[1]
,
[2]
(privex.db.query.postgres.PostgresQueryBuilder method)
,
[1]
,
[2]
(privex.db.query.sqlite.SqliteQueryBuilder method)
,
[1]
,
[2]
(tests.base.BaseQueryBuilder method)
(tests.base.SqliteQueryBuilder method)
AsyncCursorManager (class in privex.db.base)
AUTO_ZIP_COLS (privex.db.base.GenericDBWrapper attribute)
,
[1]
,
[2]
(privex.db.postgres.PostgresWrapper attribute)
B
BasePostgresTest (class in tests.test_postgres)
,
[1]
BaseQueryBuilder (class in privex.db.query.base)
,
[1]
(class in tests.base)
build_query() (privex.db.query.base.BaseQueryBuilder method)
,
[1]
,
[2]
(privex.db.query.postgres.PostgresQueryBuilder method)
,
[1]
,
[2]
(privex.db.query.sqlite.SqliteQueryBuilder method)
,
[1]
,
[2]
(tests.base.BaseQueryBuilder method)
(tests.base.SqliteQueryBuilder method)
builder() (privex.db.postgres.PostgresWrapper method)
(privex.db.sqlite.SqliteWrapper method)
C
can_cleanup (privex.db.base.AsyncCursorManager attribute)
(privex.db.base.CursorManager attribute)
,
[1]
close() (privex.db.base.CursorManager method)
(privex.db.types.GenericConnection method)
(privex.db.types.GenericCursor method)
close_cursor() (privex.db.base.GenericDBWrapper method)
(privex.db.query.base.BaseQueryBuilder method)
commit() (privex.db.types.GenericConnection method)
conn (privex.db.base.GenericAsyncDBWrapper attribute)
(privex.db.sqlite.SqliteAsyncWrapper attribute)
(tests.test_postgres.BasePostgresTest attribute)
,
[1]
,
[2]
conn() (privex.db.base.GenericDBWrapper property)
,
[1]
,
[2]
(privex.db.postgres.PostgresWrapper property)
,
[1]
,
[2]
(privex.db.query.postgres.PostgresQueryBuilder property)
(privex.db.query.sqlite.SqliteQueryBuilder property)
(privex.db.sqlite.SqliteWrapper property)
,
[1]
,
[2]
(tests.base.SqliteWrapper property)
connection (privex.db.query.base.BaseQueryBuilder attribute)
(privex.db.query.sqlite.SqliteQueryBuilder attribute)
create_schema() (privex.db.base.GenericDBWrapper method)
,
[1]
,
[2]
create_schemas() (privex.db.base.GenericDBWrapper method)
,
[1]
,
[2]
cursor() (privex.db.base.GenericDBWrapper property)
(privex.db.query.base.BaseQueryBuilder property)
(privex.db.query.postgres.PostgresQueryBuilder property)
(privex.db.types.GenericConnection method)
cursor_cls() (privex.db.postgres.PostgresWrapper property)
cursor_map (privex.db.postgres.PostgresWrapper attribute)
cursor_to_dict() (in module privex.db.base)
CursorManager (class in privex.db.base)
,
[1]
D
db (privex.db.postgres.PostgresWrapper attribute)
,
[1]
(privex.db.sqlite.SqliteAsyncWrapper attribute)
(privex.db.sqlite.SqliteWrapper attribute)
,
[1]
(tests.base.SqliteWrapper attribute)
DBExecution (class in privex.db.base)
,
[1]
DEFAULT (privex.db.query.base.QueryMode attribute)
DEFAULT_DB (privex.db.postgres.PostgresWrapper attribute)
(privex.db.sqlite.SqliteAsyncWrapper attribute)
(privex.db.sqlite.SqliteWrapper attribute)
,
[1]
,
[2]
(tests.base.ExampleWrapper attribute)
(tests.base.SqliteWrapper attribute)
(tests.test_postgres.ExamplePostgresWrapper attribute)
DEFAULT_DB_FOLDER (privex.db.sqlite.SqliteAsyncWrapper attribute)
(privex.db.sqlite.SqliteWrapper attribute)
,
[1]
,
[2]
(tests.base.SqliteWrapper attribute)
DEFAULT_DB_NAME (privex.db.sqlite.SqliteAsyncWrapper attribute)
(privex.db.sqlite.SqliteWrapper attribute)
,
[1]
,
[2]
(tests.base.SqliteWrapper attribute)
DEFAULT_ENABLE_EXECUTION_LOG (privex.db.base.GenericDBWrapper attribute)
DEFAULT_PLACEHOLDER (privex.db.base.GenericDBWrapper attribute)
,
[1]
DEFAULT_QUERY_MODE (privex.db.base.GenericDBWrapper attribute)
,
[1]
,
[2]
(privex.db.postgres.PostgresWrapper attribute)
DEFAULT_TABLE_LIST_QUERY (privex.db.base.GenericDBWrapper attribute)
(privex.db.postgres.PostgresWrapper attribute)
(privex.db.sqlite.SqliteWrapper attribute)
DEFAULT_TABLE_QUERY (privex.db.base.GenericDBWrapper attribute)
(privex.db.postgres.PostgresWrapper attribute)
(privex.db.sqlite.SqliteWrapper attribute)
description() (privex.db.base.CursorManager property)
drop_schemas() (privex.db.base.GenericDBWrapper method)
,
[1]
,
[2]
drop_table() (privex.db.base.GenericAsyncDBWrapper method)
(privex.db.base.GenericDBWrapper method)
,
[1]
,
[2]
(privex.db.postgres.PostgresWrapper method)
,
[1]
,
[2]
drop_tables() (privex.db.base.GenericDBWrapper method)
,
[1]
,
[2]
E
ExampleAsyncWrapper (class in tests.base)
ExamplePostgresWrapper (class in tests.test_postgres)
,
[1]
ExampleWrapper (class in tests.base)
,
[1]
execute() (privex.db.base.CursorManager method)
(privex.db.query.base.BaseQueryBuilder method)
(privex.db.types.GenericCursor method)
executemany() (privex.db.types.GenericCursor method)
F
fetch() (privex.db.base.GenericDBWrapper method)
,
[1]
,
[2]
(privex.db.query.base.BaseQueryBuilder method)
,
[1]
,
[2]
(privex.db.query.postgres.PostgresQueryBuilder method)
,
[1]
,
[2]
(privex.db.query.sqlite.SqliteQueryBuilder method)
,
[1]
,
[2]
(tests.base.BaseQueryBuilder method)
(tests.base.SqliteQueryBuilder method)
fetch_next() (privex.db.query.base.BaseQueryBuilder method)
,
[1]
,
[2]
(privex.db.query.postgres.PostgresQueryBuilder method)
,
[1]
,
[2]
(privex.db.query.sqlite.SqliteQueryBuilder method)
,
[1]
,
[2]
(tests.base.BaseQueryBuilder method)
(tests.base.SqliteQueryBuilder method)
fetchall() (privex.db.base.CursorManager method)
(privex.db.base.GenericDBWrapper method)
,
[1]
,
[2]
(privex.db.types.GenericCursor method)
fetchmany() (privex.db.base.CursorManager method)
(privex.db.types.GenericCursor method)
fetchone() (privex.db.base.CursorManager method)
(privex.db.base.GenericDBWrapper method)
,
[1]
,
[2]
(privex.db.types.GenericCursor method)
find_user() (tests.test_postgres.ExamplePostgresWrapper method)
G
GenericAsyncConnection (class in privex.db.types)
GenericAsyncCursor (class in privex.db.types)
GenericAsyncDBWrapper (class in privex.db.base)
GenericConnection (class in privex.db.types)
,
[1]
GenericCursor (class in privex.db.types)
,
[1]
GenericDBWrapper (class in privex.db.base)
,
[1]
get_cursor() (privex.db.base.GenericAsyncDBWrapper method)
(privex.db.base.GenericDBWrapper method)
,
[1]
,
[2]
(privex.db.query.base.BaseQueryBuilder method)
,
[1]
,
[2]
(privex.db.query.postgres.PostgresQueryBuilder method)
,
[1]
,
[2]
(privex.db.sqlite.SqliteAsyncWrapper method)
(tests.base.BaseQueryBuilder method)
group_by() (privex.db.query.base.BaseQueryBuilder method)
,
[1]
,
[2]
(tests.base.BaseQueryBuilder method)
I
insert() (privex.db.base.GenericDBWrapper method)
,
[1]
(privex.db.postgres.PostgresWrapper method)
,
[1]
(privex.db.sqlite.SqliteAsyncWrapper method)
(privex.db.sqlite.SqliteWrapper method)
,
[1]
(tests.base.SqliteWrapper method)
insert_user() (tests.test_postgres.ExamplePostgresWrapper method)
is_context_manager (privex.db.base.AsyncCursorManager attribute)
(privex.db.base.CursorManager attribute)
,
[1]
L
last_insert_id() (privex.db.postgres.PostgresWrapper method)
,
[1]
,
[2]
lastrowid() (privex.db.base.CursorManager property)
limit() (privex.db.query.base.BaseQueryBuilder method)
,
[1]
,
[2]
(tests.base.BaseQueryBuilder method)
list_tables() (privex.db.base.GenericDBWrapper method)
,
[1]
,
[2]
(privex.db.postgres.PostgresWrapper method)
,
[1]
,
[2]
M
make_connection() (privex.db.base.GenericDBWrapper method)
,
[1]
,
[2]
O
order() (privex.db.query.base.BaseQueryBuilder method)
,
[1]
,
[2]
(tests.base.BaseQueryBuilder method)
order_by() (privex.db.query.base.BaseQueryBuilder method)
,
[1]
,
[2]
(tests.base.BaseQueryBuilder method)
P
PostgresQueryBuilder (class in privex.db.query.postgres)
,
[1]
PostgresWrapper (class in privex.db.postgres)
,
[1]
privex.db.base (module)
privex.db.postgres (module)
privex.db.query.base (module)
privex.db.query.postgres (module)
privex.db.query.sqlite (module)
privex.db.sqlite (module)
privex.db.types (module)
PrivexDBTestBase (class in tests.base)
,
[1]
pytestmark (tests.test_postgres.TestPostgresBuilder attribute)
(tests.test_postgres.TestPostgresWrapper attribute)
Q
Q_DEFAULT_PLACEHOLDER (privex.db.query.base.BaseQueryBuilder attribute)
(privex.db.query.postgres.PostgresQueryBuilder attribute)
(privex.db.query.sqlite.SqliteQueryBuilder attribute)
Q_GROUP_BY_CLAUSE (privex.db.query.base.BaseQueryBuilder attribute)
Q_LIMIT_CLAUSE (privex.db.query.base.BaseQueryBuilder attribute)
Q_OFFSET_CLAUSE (privex.db.query.base.BaseQueryBuilder attribute)
Q_ORDER_CLAUSE (privex.db.query.base.BaseQueryBuilder attribute)
Q_POST_QUERY (privex.db.query.base.BaseQueryBuilder attribute)
Q_PRE_QUERY (privex.db.query.base.BaseQueryBuilder attribute)
(privex.db.query.postgres.PostgresQueryBuilder attribute)
(privex.db.query.sqlite.SqliteQueryBuilder attribute)
Q_SELECT_CLAUSE (privex.db.query.base.BaseQueryBuilder attribute)
Q_WHERE_CLAUSE (privex.db.query.base.BaseQueryBuilder attribute)
query() (privex.db.base.GenericDBWrapper method)
,
[1]
,
[2]
(privex.db.postgres.PostgresWrapper method)
,
[1]
,
[2]
query_mode (privex.db.base.GenericDBWrapper attribute)
,
[1]
query_mode_cursor() (privex.db.query.postgres.PostgresQueryBuilder method)
,
[1]
,
[2]
QueryMode (class in privex.db.query.base)
,
[1]
(class in tests.base)
R
recreate_schemas() (privex.db.base.GenericDBWrapper method)
,
[1]
,
[2]
rollback() (privex.db.types.GenericConnection method)
ROW_DICT (privex.db.query.base.QueryMode attribute)
ROW_TUPLE (privex.db.query.base.QueryMode attribute)
rowcount() (privex.db.base.CursorManager property)
S
SCHEMAS (privex.db.base.GenericDBWrapper attribute)
,
[1]
,
[2]
(tests.base.ExampleWrapper attribute)
(tests.test_postgres.ExamplePostgresWrapper attribute)
select() (privex.db.query.base.BaseQueryBuilder method)
,
[1]
,
[2]
(tests.base.BaseQueryBuilder method)
select_date() (privex.db.query.postgres.PostgresQueryBuilder method)
,
[1]
,
[2]
setUp() (tests.base.PrivexDBTestBase method)
,
[1]
,
[2]
(tests.test_postgres.BasePostgresTest method)
,
[1]
,
[2]
setUpClass() (tests.test_postgres.BasePostgresTest class method)
,
[1]
,
[2]
SqliteAsyncWrapper (class in privex.db.sqlite)
SqliteQueryBuilder (class in privex.db.query.sqlite)
,
[1]
(class in tests.base)
SqliteWrapper (class in privex.db.sqlite)
,
[1]
(class in tests.base)
T
table_exists() (privex.db.base.GenericDBWrapper method)
,
[1]
,
[2]
(privex.db.postgres.PostgresWrapper method)
,
[1]
,
[2]
tables_created (privex.db.base.GenericDBWrapper attribute)
,
[1]
,
[2]
tearDown() (tests.base.PrivexDBTestBase method)
,
[1]
,
[2]
(tests.test_postgres.BasePostgresTest method)
,
[1]
,
[2]
test_action_update() (tests.test_postgres.TestPostgresWrapper method)
(tests.test_sqlite_wrapper.TestSQLiteWrapper method)
test_all_call() (tests.test_postgres.TestPostgresBuilder method)
,
[1]
,
[2]
(tests.test_sqlite_builder.TestSQLiteBuilder method)
test_find_user_dict_mode() (tests.test_postgres.TestPostgresWrapper method)
(tests.test_sqlite_wrapper.TestSQLiteWrapper method)
test_find_user_nonexistent() (tests.test_postgres.TestPostgresWrapper method)
(tests.test_sqlite_wrapper.TestSQLiteWrapper method)
test_generator_builder() (tests.test_postgres.TestPostgresBuilder method)
,
[1]
,
[2]
(tests.test_sqlite_builder.TestSQLiteBuilder method)
,
[1]
,
[2]
test_get_users_dict() (tests.test_postgres.TestPostgresWrapper method)
(tests.test_sqlite_wrapper.TestSQLiteWrapper method)
test_get_users_tuple() (tests.test_postgres.TestPostgresWrapper method)
(tests.test_sqlite_wrapper.TestSQLiteWrapper method)
test_group_call() (tests.test_postgres.TestPostgresBuilder method)
,
[1]
,
[2]
(tests.test_sqlite_builder.TestSQLiteBuilder method)
test_index_builder() (tests.test_postgres.TestPostgresBuilder method)
,
[1]
,
[2]
(tests.test_sqlite_builder.TestSQLiteBuilder method)
,
[1]
,
[2]
test_insert_find_user() (tests.test_postgres.TestPostgresWrapper method)
(tests.test_sqlite_wrapper.TestSQLiteWrapper method)
test_iterate_builder() (tests.test_postgres.TestPostgresBuilder method)
,
[1]
,
[2]
(tests.test_sqlite_builder.TestSQLiteBuilder method)
,
[1]
,
[2]
test_query_all() (tests.test_postgres.TestPostgresBuilder method)
,
[1]
,
[2]
(tests.test_sqlite_builder.TestSQLiteBuilder method)
test_query_select_col_where() (tests.test_postgres.TestPostgresBuilder method)
,
[1]
,
[2]
(tests.test_sqlite_builder.TestSQLiteBuilder method)
test_query_select_col_where_group() (tests.test_postgres.TestPostgresBuilder method)
,
[1]
,
[2]
(tests.test_sqlite_builder.TestSQLiteBuilder method)
test_query_select_col_where_order() (tests.test_postgres.TestPostgresBuilder method)
,
[1]
,
[2]
(tests.test_sqlite_builder.TestSQLiteBuilder method)
test_query_where_first_name_last_name() (tests.test_postgres.TestPostgresBuilder method)
,
[1]
,
[2]
(tests.test_sqlite_builder.TestSQLiteBuilder method)
test_tables_created() (tests.test_postgres.TestPostgresWrapper method)
(tests.test_sqlite_wrapper.TestSQLiteWrapper method)
test_tables_drop() (tests.test_postgres.TestPostgresWrapper method)
(tests.test_sqlite_wrapper.TestSQLiteWrapper method)
test_where_call() (tests.test_postgres.TestPostgresBuilder method)
,
[1]
,
[2]
(tests.test_sqlite_builder.TestSQLiteBuilder method)
TestPostgresBuilder (class in tests.test_postgres)
,
[1]
TestPostgresWrapper (class in tests.test_postgres)
,
[1]
tests (module)
tests.base (module)
tests.test_postgres (module)
tests.test_sqlite_builder (module)
tests.test_sqlite_wrapper (module)
TestSQLiteBuilder (class in tests.test_sqlite_builder)
,
[1]
TestSQLiteWrapper (class in tests.test_sqlite_wrapper)
,
[1]
U
User (class in tests.base)
,
[1]
W
where() (privex.db.query.base.BaseQueryBuilder method)
,
[1]
,
[2]
(tests.base.BaseQueryBuilder method)
where_or() (privex.db.query.base.BaseQueryBuilder method)
,
[1]
,
[2]
(tests.base.BaseQueryBuilder method)
wrp (tests.test_postgres.BasePostgresTest attribute)
,
[1]
Read the Docs
v: latest
Versions
latest
stable
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.