neuralib.sqlp.connection.Connection

class neuralib.sqlp.connection.Connection

Bases: object

A sqlite3 connection wrapper.

If as a context manager that put itself in a global context-aware variable.

__init__(filename=':memory:', *, debug=False)

Parameters:

• filename (str | Path) – sqlite database filepath. use in-memory database by default.

• debug (bool) – print statement when executing.

Methods

__init__([filename, debug])
commit()
execute(stat[, parameter])	execute a statement.
execute_batch(stat, parameter)	execute a statement in batch mode.
execute_script(stat)	execute SQL script.
export_csv(table, file)	export a table into a csv file.
export_dataframe(table)	export a table into a DataFrame.
import_csv(table, file)	Import a table from a csv file.
import_dataframe(table, df, *[, policy])	Import a table from a DataFrame.
list_table()	list table's name stored in the database.
rollback()
sqlite_compileoption_get(n)
sqlite_compileoption_used(n)
table_schema(table)	get the table schema stored in the database.

Attributes

connection

__init__(filename=':memory:', *, debug=False)

Parameters:

• filename (str | Path) – sqlite database filepath. use in-memory database by default.

• debug (bool) – print statement when executing.

property connection: Connection

list_table()

list table’s name stored in the database.

Returns:

list of table’s name

Return type:

list[str]

table_schema(table)

get the table schema stored in the database.

Parameters:

table (str | type) – table name or type.

Returns:

table schema

Return type:

str

commit()

rollback()

execute(stat, parameter=())

execute a statement.

Parameters:

• stat (str | SqlStat) – a raw SQL statement or a SqlStat

• parameter (list[Any] | dict[str, Any]) – statement variable’s value.

Returns:

a cursor.

Return type:

Cursor

execute_batch(stat, parameter)

execute a statement in batch mode.

Parameters:

• stat (str | SqlStat) – a raw SQL statement or a SqlStat

• parameter (list) – list of statement variable’s value.

Returns:

a cursor.

Return type:

Cursor

execute_script(stat)

execute SQL script.

Parameters:

• stat (str | list[str] | list[SqlStat]) – a raw SQL script, or a list of statements/SqlStat.

• commit – commit script.

Returns:

a cursor.

sqlite_compileoption_get(n)

• https://www.sqlite.org/lang_corefunc.html#sqlite_compileoption_get

• https://www.sqlite.org/compile.html#omitfeatures

Parameters:

n

Returns:

sqlite_compileoption_used(n)

• https://www.sqlite.org/lang_corefunc.html#sqlite_compileoption_used

• https://www.sqlite.org/compile.html#omitfeatures

Parameters:

n

Returns:

Return type:

bool

export_dataframe(table)

export a table into a DataFrame.

Parameters:

table (str | type[T]) – table name or type.

Returns:

polars DataFrame

Return type:

DataFrame

import_dataframe(table, df, *, policy='REPLACE')

Import a table from a DataFrame.

Parameters:

• table (str | type[T]) – table name or type.

• df (DataFrame) – polars DataFrame

• policy (Literal['ABORT', 'FAIL', 'IGNORE', 'REPLACE', 'ROLLBACK']) – insert policy

export_csv(table, file)

export a table into a csv file.

Parameters:

• table (str | type[T]) – table name or type.

• file (str | Path) – csv filepath.

import_csv(table, file)

Import a table from a csv file.

Parameters:

• table (str | type[T]) – table name or type.

• file (str | Path) – csv filepath