SQLite3

Description

sealed class Tinman.AddOns.SQLite.SQLite3

Derived from

NativeLibrary abstract

Full source code is included in the Tinman 3D SDK download.

A partial wrapper around the C-language Interface Specification for SQLite.
https://sqlite.org/c3ref/intro.html

This wrapper contains only those parts of SQLite that are used by the Tinman 3D SDK.

Public / Constants

DONE

public constant DONE → (101:int32)

https://sqlite.org/rescode.html#done

OK

public constant OK → (0:int32)

https://sqlite.org/rescode.html#ok

OPEN_​READONLY

public constant OPEN_READONLY → (0x1:int32)

SQLITE_OPEN_READONLY
https://sqlite.org/c3ref/c_open_autoproxy.html

ROW

public constant ROW → (100:int32)

https://sqlite.org/rescode.html#row

Public / Constructors

Get

public static method Get → ()

returns → SQLite3

The native library wrapper or null iff not available.

Returns the SQLite3 wrapper for the loaded SQLite3 library.

Public / Methods

Bind​Int

public method BindInt → (3)

statement in : IntPtr

The statement.

first in : int32

First argument.

second in : int32

Second argument.

returns → int32

The result value.

sqlite3_bind_int
https://sqlite.org/c3ref/bind_blob.html

Bind​Parameter​Index

public method BindParameterIndex → (2)

statement in : IntPtr

The statement.

name in : string

First argument.

returns → int32

The result value.

sqlite3_bind_parameter_index
https://sqlite.org/c3ref/bind_parameter_index.html

Close

public method Close → (1)

database in : IntPtr

The database.

returns → int32

The result value.

sqlite3_close
https://sqlite.org/c3ref/close.html

Column​Blob

public method ColumnBlob → (2)

statement in : IntPtr

The statement.

column in : int32

The column.

returns → IntPtr

The result value.

sqlite3_column_blob
https://sqlite.org/c3ref/column_blob.html

Column​Bytes

public method ColumnBytes → (2)

statement in : IntPtr

The statement.

column in : int32

The column.

returns → int32

The result value.

sqlite3_column_bytes
https://sqlite.org/c3ref/column_blob.html

Column​Count

public method ColumnCount → (1)

statement in : IntPtr

The statement.

returns → int32

The result value.

sqlite3_column_count
https://sqlite.org/c3ref/column_count.html

Column​Int

public method ColumnInt → (2)

statement in : IntPtr

The statement.

column in : int32

The column.

returns → int32

The result value.

sqlite3_column_int
https://sqlite.org/c3ref/column_blob.html

Column​Name

public method ColumnName → (2)

statement in : IntPtr

The statement.

column in : int32

The column.

returns → string

The result value.

sqlite3_column_name
https://sqlite.org/c3ref/column_name.html

Column​Text

public method ColumnText → (2)

statement in : IntPtr

The statement.

column in : int32

The column.

returns → string

The result value.

sqlite3_column_text16
https://sqlite.org/c3ref/column_blob.html

Error​Message

public method ErrorMessage → (1)

database in : IntPtr

The database.

returns → string

The result value.

sqlite3_errmsg16
https://sqlite.org/c3ref/errcode.html

Error​Throw

public method ErrorThrow → (3)

source in : string @ Tag

The error source tag.

path in : Path

The database file path.

database in : IntPtr

The database object.

returns → IOException

The ready-to-throw exception.

Wraps the current database error message in an exception.

Finalize

public method Finalize → (1)

statement in : IntPtr

The statement.

returns → int32

The result value.

sqlite3_finalize
https://sqlite.org/c3ref/finalize.html

Open

public method Open → (4)

file in : Path

The database file path.

database out : IntPtr

The output database object.

flags opt : int32 = 0

The open flags.

vfs opt : string = null

Name of the filesystem module.

returns → int32

The result value.

sqlite3_open_v2
https://sqlite.org/c3ref/open.html

Prepare

public method Prepare → (3)

database in : IntPtr

The database.

sql in : string

The SQL statement.

statement out : IntPtr

The output statement object.

returns → int32

The result value.

sqlite3_prepare_v2
https://sqlite.org/c3ref/prepare.html

Reset

public method Reset → (1)

statement in : IntPtr

The statement.

returns → int32

The result value.

int sqlite3_reset(sqlite3_stmt *pStmt);
https://sqlite.org/c3ref/reset.html

Step

public method Step → (1)

statement in : IntPtr

The statement.

returns → int32

The result value.

int sqlite3_step(sqlite3_stmt*);
https://sqlite.org/c3ref/step.html

Public / Attributes

Is​Available

public static attribute IsAvailable → (get)

value : bool

true if the library is available,
false if not, i.e. Get will return null.

Checks if the SQLite3 library is available.