sqlite_database.table module

Table

class sqlite_database.table.Table(parent, table: str, _Table__columns: Iterable[Column] | None = None)

Bases: object

Table. Make sure you remember how the table goes.

add_column(column: Column | BuilderColumn)

Add column to table

allow_dirty()

Allow dirty queries

columns()

Table columns

commit()

Commit changes

delete(condition: dict[str, Signature | ParsedFn | Any] | list[tuple[str, Signature | ParsedFn]] | None = None, limit: int = 0, order: dict[str, Literal['asc', 'desc']] | None = None, commit: bool = True)

Delete row or rows

Parameters:

• condition (Condition, optional) – Condition to determine deletion See Signature class about conditional stuff. Defaults to None.

• limit (int, optional) – Limit deletion by integer. Defaults to 0.

• order (Optional[Orders], optional) – Order of deletion. Defaults to None.

• commit (bool, optional) – Commit changes to database (default is true)

Returns:

Rows affected

Return type:

int

delete_one(condition: dict[str, Signature | ParsedFn | Any] | list[tuple[str, Signature | ParsedFn]] | None = None, order: dict[str, Literal['asc', 'desc']] | None = None)

Delete a row

Parameters:

• condition (Condition, optional) – Conditional to determine deletion.

• None. (Defaults to)

• order (Optional[Orders], optional) – Order of deletion. Defaults to None.

property deleted

Is table deleted

disallow_dirty()

Disallow dirty queries

exists(condition: dict[str, Signature | ParsedFn | Any] | list[tuple[str, Signature | ParsedFn]] | None = None)

Check if data is exists or not.

Parameters:

condition (Condition, optional) – Condition to use. Defaults to None.

force_nodelete()

Force “undelete” table. Used if table was mistakenly assigned as deleted.

get_namespace() → Type[TypicalNamedTuple]

Generate or return pre-existed namespace/table.

insert(data: dict[str, Any], commit: bool = True)

Insert data to current table

Parameters:

• data (Data) – Data to insert. Make sure it’s compatible with the table.

• commit (bool, optional) – Commit data to database.

Returns:

Last rowid

Return type:

int

insert_many(datas: list[dict[str, Any]])

Alias to insert_multiple

insert_multiple(datas: list[dict[str, Any]], commit: bool = True)

Insert multiple values

Parameters:

• datas (Iterable[Data]) – Data to be inserted.

• commit (bool, optional) – Commit data to database

property name

Table name

paginate_select(condition: dict[str, Signature | ParsedFn | Any] | list[tuple[str, Signature | ParsedFn]] | None = None, only: tuple[str, ...] | Literal['*'] = '*', page: int = 0, length: int = 10, order: dict[str, Literal['asc', 'desc']] | None = None, squash: Literal[False] = False) → Generator[list[Row[str, Any]], None, None]

paginate_select(condition: dict[str, Signature | ParsedFn | Any] | list[tuple[str, Signature | ParsedFn]] | None = None, only: tuple[str, ...] | Literal['*'] = '*', page: int = 0, length: int = 10, order: dict[str, Literal['asc', 'desc']] | None = None, squash: Literal[True] = True) → Generator[Row[str, list[Any]], None, None]

Paginate select

Parameters:

• condition (Condition, optional) – Confitions to use. Defaults to None.

• only (OnlyColumn, optional) – Select what you want. Default to None.

• page (int) – Which page number be returned first

• length (int, optional) – Pagination length. Defaults to 10.

• order (Optional[Orders], optional) – Order. Defaults to None.

Yields:

Generator[Queries, None, None] – Step-by-step paginated result.

rename_column(old_column: str, new_column: str)

Rename existing column to new column

rollback()

Rollback

select(condition: dict[str, Signature | ParsedFn | Any] | list[tuple[str, Signature | ParsedFn]] | None = None, only: tuple[str, ...] | Literal['*'] = '*', limit: int = 0, offset: int = 0, order: dict[str, Literal['asc', 'desc']] | None = None, squash: Literal[False] = False) → list[Row[str, Any]]

select(condition: dict[str, Signature | ParsedFn | Any] | list[tuple[str, Signature | ParsedFn]] | None = None, only: tuple[str, ...] | Literal['*'] = '*', limit: int = 0, offset: int = 0, order: dict[str, Literal['asc', 'desc']] | None = None, squash: Literal[True] = True) → Row[str, list[Any]]

select(condition: dict[str, Signature | ParsedFn | Any] | list[tuple[str, Signature | ParsedFn]] | None = None, only: ParsedFn = _null, limit: int = 0, offset: int = 0, order: dict[str, Literal['asc', 'desc']] | None = None, squash: Literal[False] = False) → Any

Select data in current table. Bare .select() returns all data.

Parameters:

• condition (Condition, optional) – Conditions to used. Defaults to None.

• only – (OnlyColumn, ParsedFn, optional): Select what you want. Default to None.

• limit (int, optional) – Limit of select. Defaults to 0.

• offset (int, optional) – Offset. Defaults to 0

• order (Optional[Orders], optional) – Selection order. Defaults to None.

• squash (bool) – Is it squashed?

Returns:

Selected data

Return type:

Queries

select_one(condition: dict[str, Signature | ParsedFn | Any] | list[tuple[str, Signature | ParsedFn]] | None = None, only: ParsedFn = _null, order: dict[str, Literal['asc', 'desc']] | None = None) → Any

select_one(condition: dict[str, Signature | ParsedFn | Any] | list[tuple[str, Signature | ParsedFn]] | None = None, only: tuple[str, ...] | Literal['*'] = '*', order: dict[str, Literal['asc', 'desc']] | None = None) → Row[str, Any]

select_one(condition: dict[str, Signature | ParsedFn | Any] | list[tuple[str, Signature | ParsedFn]] | None = None, only: str = '_COLUMN', order: dict[str, Literal['asc', 'desc']] | None = None) → Any

Select one data

Parameters:

• condition (Condition, optional) – Condition to use. Defaults to None.

• only – (OnlyColumn, optional): Select what you want. Default to None.

• order (Optional[Orders], optional) – Order of selection. Defaults to None.

Returns:

Selected data

Return type:

Any

update(condition: dict[str, Signature | ParsedFn | Any] | list[tuple[str, Signature | ParsedFn]] | None = None, data: dict[str, Any] | None = None, limit: int = 0, order: dict[str, Literal['asc', 'desc']] | None = None, commit: bool = True)

Update rows of current table

Parameters:

• data (Data) – New data to update

• condition (Condition, optional) – Condition dictionary. See Signature about how condition works. Defaults to None.

• limit (int, optional) – Limit updates. Defaults to 0.

• order (Optional[Orders], optional) – Order of change. Defaults to None.

• commit (bool, optional) – Commit data to database

Returns:

Rows affected

Return type:

int

update_one(condition: dict[str, Signature | ParsedFn | Any] | list[tuple[str, Signature | ParsedFn]] | None = None, new_data: dict[str, Any] | None = None, order: dict[str, Literal['asc', 'desc']] | None = None) → int

Update 1 data only