コンテンツにスキップ

SQLite/コマンドリファレンス

出典: フリー教科書『ウィキブックス(Wikibooks)』


以下は、SQLiteのコマンドリファレンスマニュアルです。各コマンドの説明と使用方法を記載しています。

.auth ON|OFF

[編集]
  • 説明: 認可コールバックを表示するかどうかを設定します。
  • 使用方法: .auth ON または .auth OFF

.backup ?DB? FILE

[編集]
  • 説明: 指定されたデータベース(デフォルトは "main")を指定されたファイルにバックアップします。
  • 使用方法: .backup main backup_file.db

.bail on|off

[編集]
  • 説明: エラーが発生した後に停止するかどうかを設定します。デフォルトは OFF です。
  • 使用方法: .bail ON または .bail OFF

.cd DIRECTORY

[編集]
  • 説明: 作業ディレクトリを指定されたディレクトリに変更します。
  • 使用方法: .cd /path/to/directory

.changes on|off

[編集]
  • 説明: SQLによって変更された行数を表示するかどうかを設定します。
  • 使用方法: .changes ON または .changes OFF

.check GLOB

[編集]
  • 説明: .testcase 以降の出力が指定されたGLOBパターンに一致しない場合に失敗します。
  • 使用方法: .check pattern

.clone NEWDB

[編集]
  • 説明: 既存のデータベースから新しいデータベースにデータをクローンします。
  • 使用方法: .clone new_database.db

.connection [close] [#]

[編集]
  • 説明: 補助データベース接続を開くか閉じます。
  • 使用方法: .connection close 1

.crlf ?on|off?

[編集]
  • 説明: 行末に \r\n を使用するかどうかを設定します。
  • 使用方法: .crlf ON または .crlf OFF

.databases

[編集]
  • 説明: 接続されているデータベースの名前とファイルをリストします。
  • 使用方法: .databases

.dbconfig ?op? ?val?

[編集]
  • 説明: sqlite3_db_config() オプションをリストまたは変更します。
  • 使用方法: .dbconfig

.dbinfo ?DB?

[編集]
  • 説明: データベースのステータス情報を表示します。
  • 使用方法: .dbinfo main

.dbtotxt

[編集]
  • 説明: データベースファイルの16進ダンプを表示します。
  • 使用方法: .dbtotxt

.dump ?OBJECTS?

[編集]
  • 説明: データベースの内容をSQLとして出力します。
  • 使用方法: .dump

.echo on|off

[編集]
  • 説明: コマンドエコーを有効または無効にします。
  • 使用方法: .echo ON または .echo OFF

.eqp on|off|full|...

[編集]
  • 説明: 自動的な EXPLAIN QUERY PLAN を有効または無効にします。
  • 使用方法: .eqp ON

.excel

[編集]
  • 説明: 次のコマンドの出力をスプレッドシート形式で表示します。
  • 使用方法: .excel

.exit ?CODE?

[編集]
  • 説明: プログラムを終了し、指定されたリターンコードを返します。
  • 使用方法: .exit 0

.expert

[編集]
  • 説明: クエリのためのインデックスを提案します(実験的機能)。
  • 使用方法: .expert

.explain ?on|off|auto?

[編集]
  • 説明: EXPLAIN フォーマットモードを変更します。デフォルトは auto です。
  • 使用方法: .explain ON

.filectrl CMD ...

[編集]
  • 説明: 様々な sqlite3_file_control() 操作を実行します。
  • 使用方法: .filectrl

.fullschema ?--indent?

[編集]
  • 説明: スキーマと sqlite_stat テーブルの内容を表示します。
  • 使用方法: .fullschema

.headers on|off

[編集]
  • 説明: ヘッダーの表示を有効または無効にします。
  • 使用方法: .headers ON

.help ?-all? ?PATTERN?

[編集]
  • 説明: 指定されたパターンに一致するヘルプテキストを表示します。
  • 使用方法: .help .backup

.import FILE TABLE

[編集]
  • 説明: ファイルからデータをテーブルにインポートします。
  • 使用方法: .import data.csv my_table

.indexes ?TABLE?

[編集]
  • 説明: 指定されたテーブルのインデックス名を表示します。
  • 使用方法: .indexes my_table

.intck ?STEPS_PER_UNLOCK?

[編集]
  • 説明: データベースの増分整合性チェックを実行します。
  • 使用方法: .intck

.limit ?LIMIT? ?VAL?

[編集]
  • 説明: SQLITE_LIMIT の値を表示または変更します。
  • 使用方法: .limit

.lint OPTIONS

[編集]
  • 説明: 潜在的なスキーマの問題を報告します。
  • 使用方法: .lint

.load FILE ?ENTRY?

[編集]
  • 説明: 拡張ライブラリをロードします。
  • 使用方法: .load my_extension.so

.log FILE|on|off

[編集]
  • 説明: ロギングを有効または無効にします。ファイルは stderr または stdout に指定できます。
  • 使用方法: .log ON

.mode MODE ?OPTIONS?

[編集]
  • 説明: 出力モードを設定します。
  • 使用方法: .mode csv

.nonce STRING

[編集]
  • 説明: 指定された nonce が一致する場合、セーフモードを一時的に解除します。
  • 使用方法: .nonce my_nonce

.nullvalue STRING

[編集]
  • 説明: NULL 値の代わりに使用する文字列を設定します。
  • 使用方法: .nullvalue NULL

.once ?OPTIONS? ?FILE?

[編集]
  • 説明: 次のSQLコマンドの出力を指定されたファイルに出力します。
  • 使用方法: .once output.txt

.open ?OPTIONS? ?FILE?

[編集]
  • 説明: 既存のデータベースを閉じ、指定されたファイルを開きます。
  • 使用方法: .open new_database.db

.output ?FILE?

[編集]
  • 説明: 出力を指定されたファイルまたは標準出力に送ります。
  • 使用方法: .output output.txt

.parameter CMD ...

[編集]
  • 説明: SQLパラメータバインディングを管理します。
  • 使用方法: .parameter

.print STRING...

[編集]
  • 説明: 指定された文字列を出力します。
  • 使用方法: .print Hello, World!

.progress N

[編集]
  • 説明: 毎回 N オペコード後にプログレスハンドラを呼び出します。
  • 使用方法: .progress 100

.prompt MAIN CONTINUE

[編集]
  • 説明: 標準のプロンプトを置き換えます。
  • 使用方法: .prompt "sqlite> " " ...> "

.quit

[編集]
  • 説明: 入力ストリームの解釈を停止し、プライマリプロセスを終了します。
  • 使用方法: .quit

.read FILE

[編集]
  • 説明: 指定されたファイルまたはコマンド出力から入力を読み取ります。
  • 使用方法: .read script.sql

.recover

[編集]
  • 説明: 破損したデータベースから可能な限りのデータを回復します。
  • 使用方法: .recover

.restore ?DB? FILE

[編集]
  • 説明: 指定されたファイルからデータベースの内容を復元します。
  • 使用方法: .restore main backup_file.db

.save ?OPTIONS? FILE

[編集]
  • 説明: データベースを指定されたファイルに保存します(.backup のエイリアス)。
  • 使用方法: .save backup_file.db

.scanstats on|off|est

[編集]
  • 説明: sqlite3_stmt_scanstatus() メトリクスを有効または無効にします。
  • 使用方法: .scanstats ON

.schema ?PATTERN?

[編集]
  • 説明: 指定されたパターンに一致する CREATE ステートメントを表示します。
  • 使用方法: .schema my_table

.separator COL ?ROW?

[編集]
  • 説明: カラムと行の区切り文字を変更します。
  • 使用方法: .separator ,

.session ?NAME? CMD ...

[編集]
  • 説明: セッションを作成または制御します。
  • 使用方法: .session

.sha3sum ...

[編集]
  • 説明: データベース内容のSHA3ハッシュを計算します。
  • 使用方法: .sha3sum

.shell CMD ARGS...

[編集]
  • 説明: システムシェルでコマンドを実行します。
  • 使用方法: .shell ls -l

.show

[編集]
  • 説明: 現在の設定値を表示します。
  • 使用方法: .show

.stats ?ARG?

[編集]
  • 説明: 統計情報を表示または統計の有効/無効を切り替えます。
  • 使用方法: .stats ON

.system CMD ARGS...

[編集]
  • 説明: システムシェルでコマンドを実行します。
  • 使用方法: .system ls -l

.tables ?TABLE?

[編集]
  • 説明: 指定されたパターンに一致するテーブル名をリストします。
  • 使用方法: .tables my_table

.timeout MS

[編集]
  • 説明: ロックされたテーブルを指定されたミリ秒間開こうとします。
  • 使用方法: .timeout 5000

.timer on|off

[編集]
  • 説明: SQLタイマーを有効または無効にします。
  • 使用方法: .timer ON

.trace ?OPTIONS?

[編集]
  • 説明: 各SQLステートメントを実行時に出力します。
  • 使用方法: .trace

.version

[編集]
  • 説明: ソース、ライブラリ、コンパイラのバージョンを表示します。
  • 使用方法: .version

.vfsinfo ?AUX?

[編集]
  • 説明: トップレベルのVFSに関する情報を表示します。
  • 使用方法: .vfsinfo

.vfslist

[編集]
  • 説明: 利用可能なすべてのVFSをリストします。
  • 使用方法: .vfslist

.vfsname ?AUX?

[編集]
  • 説明: VFSスタックの名前を表示します。
  • 使用方法: .vfsname

.width NUM1 NUM2 ...

[編集]
  • 説明: カラム出力の最小幅を設定します。
  • 使用方法: .width 10 20

.www

[編集]
  • 説明: 次のコマンドの出力をウェブブラウザで表示します。
  • 使用方法: .www

このマニュアルは、SQLiteのコマンドラインインターフェースで使用できる主要なコマンドを網羅しています。各コマンドの詳細な使用方法やオプションについては、SQLiteの公式ドキュメントを参照してください。