Home / Core / SQLite
Core

SQLite

SQLite database helper.

3 nested API groups

Import

from Xenonix.Core import SQLite

Search this API

Filter methods, arguments, and configuration keys on this page.

Configuration

Use Config(...) with these keys where the class exposes configuration.

This object does not expose a public Config table.

Nested APIs

These are public helper types grouped under the main class.

Connect

Connect API available from the Core library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Connect instance.

Create(Path)

Arguments

Argument Default Accepted values What it does
Path Required Any valid value File path used for reading or writing.

Output

Creates a new Connect object.

GetConnection

Runs the GetConnection operation for Connect.

GetConnection()

Arguments

No arguments.

Output

Returns the calculated result.

Get

Runs the Get operation for Connect.

Get(Command, Keys=True)

Arguments

Argument Default Accepted values What it does
Command Required SELECT * Mode/value selector for command.
Keys True Any valid value Turns keys on or off.

Output

Returns the calculated result.

Post

Runs the Post operation for Connect.

Post(Command)

Arguments

Argument Default Accepted values What it does
Command Required Any valid value Command value used by the operation.

Output

Returns True/False to indicate success.

Resolve_Base_Path

Runs the Resolve_Base_Path operation for Connect.

Resolve_Base_Path()

Arguments

No arguments.

Output

Returns the calculated result.

Checkpoint

Runs the Checkpoint operation for Connect.

Checkpoint(Mode='TRUNCATE', Timeout=5000)

Arguments

Argument Default Accepted values What it does
Mode 'TRUNCATE' Any valid value Mode selector for the operation.
Timeout 5000 Any valid value Timeout value used by the operation.

Output

Returns the calculated result.

Close_All

Runs the Close_All operation for Connect.

Close_All()

Arguments

No arguments.

Output

Runs the operation. Some methods update the object in place.

Close

Applies a morphology-style image operation.

Close(Retries=40, Delay=0.05)

Arguments

Argument Default Accepted values What it does
Retries 40 Any valid value Retries value used by the operation.
Delay 0.05 Any valid value Delay value used by the operation.

Output

Returns success/status or the operation result.

Server

Server API available from the Core library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Server instance.

Create(Database=None, Host='127.0.0.1', Port=3306, Protocol='DGRAM', Type='TCPIP', SessionTtl=None, DefaultDatabase='Default', Key=None)

Arguments

Argument Default Accepted values What it does
Database None Any valid value Database value used by the operation.
Host '127.0.0.1' Any valid value Host value used by the operation.
Port 3306 Any valid value Port value used by the operation.
Protocol 'DGRAM' Any valid value Protocol value used by the operation.
Type 'TCPIP' Any valid value Type value used by the operation.
SessionTtl None Any valid value SessionTtl value used by the operation.
DefaultDatabase 'Default' Any valid value DefaultDatabase value used by the operation.
Key None Any valid value Key value used by the operation.

Output

Creates a new Server object.

Ping

Runs the Ping operation for Server.

Ping(Arg=None, KArg=None)

Arguments

Argument Default Accepted values What it does
Arg None Any valid value Arg value used by the operation.
KArg None Any valid value KArg value used by the operation.

Output

Returns True/False to indicate success.

Add_Database

Adds a new item to the object or UI.

Add_Database(Name, Path)

Arguments

Argument Default Accepted values What it does
Name Required Any valid value Display/name identifier.
Path Required Any valid value File path used for reading or writing.

Output

Adds a new item and returns the created object/id when available.

Remove_Database

Removes the requested item.

Remove_Database(Name)

Arguments

Argument Default Accepted values What it does
Name Required Any valid value Display/name identifier.

Output

Returns True/False to indicate success.

Add_User

Adds a new item to the object or UI.

Add_User(Username, Password, Databases=None)

Arguments

Argument Default Accepted values What it does
Username Required Any valid value Username value used by the operation.
Password Required Any valid value Password value used by the operation.
Databases None Any valid value Databases value used by the operation.

Output

Adds a new item and returns the created object/id when available.

Remove_User

Removes the requested item.

Remove_User(Username)

Arguments

Argument Default Accepted values What it does
Username Required Username Mode/value selector for username.

Output

Returns True/False to indicate success.

Login

Runs the Login operation for Server.

Login(Arg=None, KArg=None)

Arguments

Argument Default Accepted values What it does
Arg None Any valid value Arg value used by the operation.
KArg None Any valid value KArg value used by the operation.

Output

Returns structured data such as a list or dictionary.

Get

Runs the Get operation for Server.

Get(Arg=None, KArg=None)

Arguments

Argument Default Accepted values What it does
Arg None Any valid value Arg value used by the operation.
KArg None Any valid value KArg value used by the operation.

Output

Returns structured data such as a list or dictionary.

Post

Runs the Post operation for Server.

Post(Arg=None, KArg=None)

Arguments

Argument Default Accepted values What it does
Arg None Any valid value Arg value used by the operation.
KArg None Any valid value KArg value used by the operation.

Output

Returns structured data such as a list or dictionary.

Checkpoint

Runs the Checkpoint operation for Server.

Checkpoint(Arg=None, KArg=None)

Arguments

Argument Default Accepted values What it does
Arg None Any valid value Arg value used by the operation.
KArg None Any valid value KArg value used by the operation.

Output

Returns structured data such as a list or dictionary.

Start

Starts the process or connection.

Start()

Arguments

No arguments.

Output

Returns success/status or the operation result.

Close

Applies a morphology-style image operation.

Close()

Arguments

No arguments.

Output

Returns success/status or the operation result.

Client

Client API available from the Core library.

Configuration

This object does not expose a public Config table.

Methods

Create

Creates a new Client instance.

Create(Database=None, Host='127.0.0.1', Port=3306, User=None, Pass=None, Timeout=0.1, Protocol='DGRAM', Type='TCPIP', AutoLogin=True, Key=None)

Arguments

Argument Default Accepted values What it does
Database None Any valid value Database value used by the operation.
Host '127.0.0.1' Any valid value Host value used by the operation.
Port 3306 Any valid value Port value used by the operation.
User None Any valid value User value used by the operation.
Pass None Any valid value Pass value used by the operation.
Timeout 0.1 Any valid value Timeout value used by the operation.
Protocol 'DGRAM' Any valid value Protocol value used by the operation.
Type 'TCPIP' Any valid value Type value used by the operation.
AutoLogin True Any valid value Turns autologin on or off.
Key None Any valid value Key value used by the operation.

Output

Creates a new Client object.

Reconnect

Runs the Reconnect operation for Client.

Reconnect()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Ping

Runs the Ping operation for Client.

Ping()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Login

Runs the Login operation for Client.

Login(Username=None, Password=None, Database=None)

Arguments

Argument Default Accepted values What it does
Username None Any valid value Username value used by the operation.
Password None Any valid value Password value used by the operation.
Database None Any valid value Database value used by the operation.

Output

Returns True/False to indicate success.

Get

Runs the Get operation for Client.

Get(Command, Keys=True, Database=None)

Arguments

Argument Default Accepted values What it does
Command Required Any valid value Command value used by the operation.
Keys True Any valid value Turns keys on or off.
Database None Any valid value Database value used by the operation.

Output

Returns the calculated result.

Post

Runs the Post operation for Client.

Post(Command, Database=None)

Arguments

Argument Default Accepted values What it does
Command Required Any valid value Command value used by the operation.
Database None Any valid value Database value used by the operation.

Output

Returns True/False to indicate success.

Checkpoint

Runs the Checkpoint operation for Client.

Checkpoint(Mode='TRUNCATE', Timeout=5000, Database=None)

Arguments

Argument Default Accepted values What it does
Mode 'TRUNCATE' Any valid value Mode selector for the operation.
Timeout 5000 Any valid value Timeout value used by the operation.
Database None Any valid value Database value used by the operation.

Output

Returns the calculated result.

Close

Applies a morphology-style image operation.

Close()

Arguments

No arguments.

Output

Returns success/status or the operation result.