SQLite3 クラス

(PHP 5 >= 5.3.0, PHP 7, PHP 8)

はじめに

SQLite 3 データベースとのインターフェイスとなるクラスです。

クラス概要

class SQLite3 {

/* 定数 */

public const int OK;

public const int DENY;

public const int IGNORE;

public const int CREATE_INDEX;

public const int CREATE_TABLE;

public const int CREATE_TEMP_INDEX;

public const int CREATE_TEMP_TABLE;

public const int CREATE_TEMP_TRIGGER;

public const int CREATE_TEMP_VIEW;

public const int CREATE_TRIGGER;

public const int CREATE_VIEW;

public const int DELETE;

public const int DROP_INDEX;

public const int DROP_TABLE;

public const int DROP_TEMP_INDEX;

public const int DROP_TEMP_TABLE;

public const int DROP_TEMP_TRIGGER;

public const int DROP_TEMP_VIEW;

public const int DROP_TRIGGER;

public const int DROP_VIEW;

public const int INSERT;

public const int PRAGMA;

public const int READ;

public const int SELECT;

public const int TRANSACTION;

public const int UPDATE;

public const int ATTACH;

public const int DETACH;

public const int ALTER_TABLE;

public const int REINDEX;

public const int ANALYZE;

public const int CREATE_VTABLE;

public const int DROP_VTABLE;

public const int FUNCTION;

public const int SAVEPOINT;

public const int COPY;

public const int RECURSIVE;

/* メソッド */

public function __construct(string $filename, int $flags = SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, string $encryptionKey = "")

public function backup(SQLite3 $destination, string $sourceDatabase = "main", string $destinationDatabase = "main"): bool

public function busyTimeout(int $milliseconds): bool

public function changes(): int

public function close(): bool

public function createAggregate(
    string $name,
    callable $stepCallback,
    callable $finalCallback,
    int $argCount = -1
): bool

public function createCollation(string $name, callable $callback): bool

public function createFunction(
    string $name,
    callable $callback,
    int $argCount = -1,
    int $flags = 0
): bool

public function enableExceptions(bool $enable = false): bool

public function enableExtendedResultCodes(bool $enable = true): bool

public static function escapeString(string $string): string

public function exec(string $query): bool

public function lastErrorCode(): int

public function lastErrorMsg(): string

public function lastExtendedErrorCode(): int

public function lastInsertRowID(): int

public function loadExtension(string $name): bool

public function open(string $filename, int $flags = SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE, string $encryptionKey = ""): void

public function openBlob(
    string $table,
    string $column,
    int $rowid,
    string $database = "main",
    int $flags = SQLITE3_OPEN_READONLY
): resource|false

public function prepare(string $query): SQLite3Stmt|false

public function query(string $query): SQLite3Result|false

public function querySingle(string $query, bool $entireRow = false): mixed

public function setAuthorizer(?callable $callback): bool

public static function version(): array

}

定義済み定数

SQLite3::OK: authorizer コールバックがこの値を返すと、そのアクションが許可されます。
SQLite3::DENY: authorizer コールバックがこの値を返すと、エラーが発生し、SQL文全体が拒否されます。
SQLite3::IGNORE: authorizer コールバックがこの値を返すと、 SQL文のコンパイルは許可しつつ、個別のアクションだけを不許可にします。アクションごとの効果については SQLite3::setAuthorizer() を参照ください。
SQLite3::CREATE_INDEX
SQLite3::CREATE_TABLE
SQLite3::CREATE_TEMP_INDEX
SQLite3::CREATE_TEMP_TABLE
SQLite3::CREATE_TEMP_TRIGGER
SQLite3::CREATE_TEMP_VIEW
SQLite3::CREATE_TRIGGER
SQLite3::CREATE_VIEW
SQLite3::DELETE
SQLite3::DROP_INDEX
SQLite3::DROP_TABLE
SQLite3::DROP_TEMP_INDEX
SQLite3::DROP_TEMP_TABLE
SQLite3::DROP_TEMP_TRIGGER
SQLite3::DROP_TEMP_VIEW
SQLite3::DROP_TRIGGER
SQLite3::DROP_VIEW
SQLite3::INSERT
SQLite3::PRAGMA
SQLite3::READ
SQLite3::SELECT
SQLite3::TRANSACTION
SQLite3::UPDATE
SQLite3::ATTACH
SQLite3::DETACH
SQLite3::ALTER_TABLE
SQLite3::REINDEX
SQLite3::ANALYZE
SQLite3::CREATE_VTABLE
SQLite3::DROP_VTABLE
SQLite3::FUNCTION
SQLite3::SAVEPOINT
SQLite3::COPY
SQLite3::RECURSIVE

変更履歴

バージョン	説明
8.4.0	クラス定数が型付けされるようになりました。

SQLite3::backup — あるデータベースを、別のデータベースにバックアップする
SQLite3::busyTimeout — 接続がビジー状態のときのハンドラを設定する
SQLite3::changes — 直近の SQL 文で変更 (あるいは挿入、削除) された行の数を返す
SQLite3::close — データベースとの接続を閉じる
SQLite3::__construct — SQLite3 オブジェクトを作成し、SQLite 3 データベースをオープンする
SQLite3::createAggregate — SQL の集約関数として使用する PHP 関数を登録する
SQLite3::createCollation — SQLのcollate関数として使うPHP関数を登録する
SQLite3::createFunction — SQL のスカラー関数として使用する PHP 関数を登録する
SQLite3::enableExceptions — 例外のスローを有効にする
SQLite3::enableExtendedResultCodes — 拡張結果コードの使用を有効または無効にする
SQLite3::escapeString — 適切にエスケープされた文字列を返す
SQLite3::exec — 指定したデータベースに、結果を返さないクエリを実行する
SQLite3::lastErrorCode — 直近で失敗した SQLite リクエストの結果コードを数値で返す
SQLite3::lastErrorMsg — 直近で失敗した SQLite リクエストについての英文テキストの説明を返す
SQLite3::lastExtendedErrorCode — 直近で失敗した SQLite リクエストの拡張結果コードを数値で返す
SQLite3::lastInsertRowID — 直近の INSERT 文でデータベースに追加された行の ID を返す
SQLite3::loadExtension — SQLite 拡張ライブラリを読み込む
SQLite3::open — SQLite データベースをオープンする
SQLite3::openBlob — BLOB を読み取るためのストリームリソースを開く
SQLite3::prepare — 実行する SQL 文を準備する
SQLite3::query — SQL クエリを実行する
SQLite3::querySingle — クエリを実行し、単一の結果を返す
SQLite3::setAuthorizer — SQL文が出来ることを限定するため、authorizer として使われるコールバックを設定する
SQLite3::version — SQLite3 ライブラリのバージョンを、文字列定数と数値で返す

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes

There are no user contributed notes for this page.