C言語DB入門|SQLiteプログラムをコンパイルして実行する

C言語DB入門|SQLiteプログラムをコンパイルして実行する

この記事では、前の記事で作成した db_sample.c をコンパイルし、SQLiteデータベースを開くプログラムを実行します。

普通のC言語プログラムと同じように、コンパイルにはGCCを使います。ただし、SQLiteの関数を利用するために、SQLiteライブラリを組み合わせる指定が必要です。

まずは短いコマンドで動かしてから、各オプションの意味を確認していきましょう。

  • SQLiteプログラムのコンパイル方法
  • -lsqlite3 を指定する理由
  • ヘッダーファイル、ライブラリ、DLLの役割
  • プログラムの実行方法と結果の確認
  • コンパイル時や実行時にエラーが出たときの確認方法

作業には、第2章で準備したMSYS2 UCRT64を使用します。

コンパイルすると何ができるのか

C言語で書いたソースコードは、そのままではWindows上で実行できません。GCCを使って、Windowsで実行できる実行ファイルを作成します。

今回扱うファイルは、次の3つです。

ファイル名役割
db_sample.cSQLiteデータベースを開いて閉じるC言語のソースファイル
db_sample.exeコンパイルによって作成する実行ファイル
books.dbプログラムの実行時に開くSQLiteデータベースファイル

ここで押さえておきたいのは、books.db はコンパイルするファイルではないという点です。

GCCには db_sample.c を渡します。作成された db_sample.exe を実行すると、プログラムが books.db を開きます。

そのため、書籍のデータを変更しただけなら、実行ファイルを作り直す必要はありません。C言語のソースコードを変更したときに、再びコンパイルします。

図1:ソースコードからデータベースを開くまで

この図から分かること

ソースコードから実行ファイルを作る作業と、実行ファイルからデータベースを開く作業は、別の段階です。

SQLiteの機能を使えるように実行ファイルを作り、その実行時に books.db へアクセスします。データベースの内容が実行ファイルに取り込まれるわけではありません。

MSYS2 UCRT64で作業場所を確認する

MSYS2 UCRT64を起動してください。VS Codeで設定したUCRT64の統合ターミナルを使ってもかまいません。

最初に、使用している環境を確認します。

echo "$MSYSTEM"

実行結果の例です。

UCRT64

続いて、第3章の作業ディレクトリへ移動します。

cd /c/c-db/chap03

現在のディレクトリを確認しましょう。

pwd

実行結果の例です。

/c/c-db/chap03

Windowsの C:\c-db\chap03 と、MSYS2の /c/c-db/chap03 は、同じ場所を指しています。

使用するGCCも確認します。

command -v gcc

実行結果の例です。

/ucrt64/bin/gcc

UCRT64では、通常、コマンドを探すためのPATHの先頭側に /ucrt64/bin が設定されます。この環境でUCRT64用のGCCやSQLiteを使用します。

ソースファイルとデータベースを確認する

次のコマンドで、今回使用するファイルを確認します。

ls -1 db_sample.c books.db

実行結果の例です。

books.db
db_sample.c

db_sample.c が見つからない場合は、VS Codeで保存した場所を確認してください。

books.db は、これまでSQLを使って操作してきたデータベースです。今回は、そのファイルをC言語から開きます。

コンパイルするプログラムを確認する

前の記事で作成したプログラムを、ここでも掲載します。すでに保存してある場合は、同じ内容になっているか確認してください。

このプログラムは、データベースを開き、接続に成功したことを表示してから接続を閉じます。書籍の登録・変更・削除は行いません。

books.db を開いて接続を閉じるプログラム

ファイル名: db_sample.c

#include <stdio.h>
#include <stdlib.h>
#include <sqlite3.h>

int main(void)
{
    sqlite3 *db = NULL;
    const char *db_path = "books.db";
    int rc;

    rc = sqlite3_open(db_path, &db);

    if (rc != SQLITE_OK) {
        fprintf(stderr, "Failed to open database (code %d).\n", rc);

        if (db != NULL) {
            fprintf(stderr, "Details: %s\n", sqlite3_errmsg(db));
            sqlite3_close(db);
        }

        return EXIT_FAILURE;
    }

    printf("Opened database: %s\n", db_path);

    rc = sqlite3_close(db);

    if (rc != SQLITE_OK) {
        fprintf(stderr, "Failed to close database: %s\n",
                sqlite3_errmsg(db));
        return EXIT_FAILURE;
    }

    db = NULL;
    printf("Closed database.\n");

    return EXIT_SUCCESS;
}

プログラムの処理を振り返る

主要な処理は、次のとおりです。

記述役割
#include <sqlite3.h>SQLiteの関数や型の宣言を読み込む
sqlite3 *db = NULL;データベース接続を扱うポインターを用意する
sqlite3_open(db_path, &db)books.db を開き、接続を受け取る
rc != SQLITE_OKSQLiteの処理が成功したか確認する
sqlite3_errmsg(db)接続に関するエラーメッセージを取得する
sqlite3_close(db)データベース接続を閉じる
return EXIT_SUCCESS;プログラムの正常終了を知らせる

データベースを開く処理が失敗しても、接続を扱うオブジェクトが作成されている場合があります。そのため、エラー処理でも db が NULL でなければ sqlite3_close を呼び出しています。

今回は、これらの関数を含むソースコードを、実行できる形にする方法に注目しましょう。

短いコマンドでコンパイルする

VS Codeで db_sample.c を保存してから、MSYS2 UCRT64で次のコマンドを実行します。

gcc db_sample.c -o db_sample.exe -lsqlite3

これが、今回の環境で使う基本のコンパイルコマンドです。

成功すると、通常はメッセージが表示されず、次のコマンドを入力できる状態に戻ります。同じディレクトリに db_sample.exe が作成されます。

コマンドの部分意味
gccGCCを起動する
db_sample.cコンパイルするソースファイルを指定する
-o db_sample.exe出力する実行ファイルの名前を指定する
-lsqlite3SQLiteライブラリをリンクする

-o の文字は、数字の0ではなく、英小文字のオーです。

また、-lsqlite3 の先頭は、ハイフンに続く英小文字のエルです。数字の1ではありません。

警告を有効にしてコンパイルする

学習中は、次のようにC言語の規格と警告オプションを指定する方法もおすすめです。

gcc -std=c17 -Wall -Wextra db_sample.c -o db_sample.exe -lsqlite3

短いコマンドに、次のオプションを追加しています。

オプション意味
-std=c17C17の規格に基づいてコンパイルする
-Wallよく使われる警告を有効にする
-Wextra-Wall に加えて、さらに警告を有効にする

-Wall は、名前からすべての警告を有効にするように見えますが、GCCの警告すべてを有効にする指定ではありません。

短いコマンドと警告付きのコマンドは、どちらか一方を実行すれば大丈夫です。これからプログラムを書き進めるときは、警告付きのコマンドを使うと、問題に気づきやすくなります。

-lsqlite3 が必要な理由

ソースコードには、次の記述があります。

#include <sqlite3.h>

sqlite3.h には、SQLiteの関数を呼び出すために必要な宣言や型の情報が書かれています。

ただし、ヘッダーファイルを読み込んだだけでは、SQLiteの処理本体と結び付いた実行ファイルは作れません。

たとえば、GCCが sqlite3_open の呼び出しを確認できても、その関数の処理をどこから利用するのか決める必要があります。

そこで指定するのが、-lsqlite3 です。

コンパイルとリンクの違い

実行ファイルを作る処理には、大きく分けてコンパイルとリンクがあります。

処理主な役割
コンパイルソースコードを解析し、機械語のコードへ変換する
リンク変換したコードと、必要な関数やライブラリを結び付ける

普段は、これらをまとめて「コンパイルする」と呼ぶこともあります。

今回のgccコマンドは、コンパイルからリンクまでを一度に行います。-lsqlite3 は、そのリンクでSQLiteライブラリを指定するオプションです。

ライブラリの指定はソースファイルより後ろに置く

今回のコマンドでは、-lsqlite3 を末尾に置いています。

gcc db_sample.c -o db_sample.exe -lsqlite3

GCCでは、リンクするファイルやライブラリを指定する順序が結果に影響することがあります。ライブラリを使うソースファイルを先に、ライブラリの指定を後に置く形で覚えておきましょう。

SQLiteを使うための3種類のファイル

第2章でインストールしたUCRT64用SQLiteには、コマンドラインから操作するプログラムだけでなく、C言語から利用するためのファイルも含まれています。

通常の構成では、次のファイルが使われます。

種類MSYS2上のパス主に使うタイミング
ヘッダーファイル/ucrt64/include/sqlite3.hコンパイル時
インポートライブラリ/ucrt64/lib/libsqlite3.dll.aリンク時
DLL/ucrt64/bin/libsqlite3-0.dll実行時

これらは、mingw-w64-ucrt-x86_64-sqlite3 パッケージに含まれています。

インポートライブラリは、実行時にDLLの関数を利用できるよう、リンクの段階で結び付けるためのファイルです。DLLには、実行時に利用するSQLiteの処理本体が入っています。

今回のように、UCRT64用のGCCとSQLiteを標準の場所にインストールしている場合は、通常、ヘッダーやライブラリの場所を追加で指定する必要はありません。

なお、sqlite3 コマンドとして起動する sqlite3.exe は、SQLを対話的に入力するための別のプログラムです。db_sample.exe が内部で sqlite3.exe を起動しているわけではありません。

図2:ヘッダー・ライブラリ・DLLの役割

この図から分かること

ヘッダーファイル、インポートライブラリ、DLLは、それぞれ役割が異なります。

コンパイル時に宣言を確認し、リンク時にDLLの関数と結び付け、実行時にDLLを利用します。この違いを知っておくと、エラーが出たときに確認する場所を絞れます。

作成したプログラムを実行する

コンパイルに成功したら、同じMSYS2 UCRT64のターミナルで実行します。

./db_sample.exe

先頭の ./ は、現在のディレクトリにある実行ファイルを指定しています。

実行結果の例

Opened database: books.db
Closed database.

1行目は、books.db を開く処理に成功したことを示しています。

2行目は、データベース接続を閉じる処理に成功したことを示しています。

このプログラムにはSELECTの処理がないため、登録済みの書籍は表示されません。また、データを変更するSQLも実行していないので、既存の書籍データはそのままです。

プログラムの終了状態を確認する

実行直後に、次のコマンドを入力すると、終了状態を確認できます。

echo $?

正常終了した場合の例です。

0

$? は、直前に実行したコマンドの終了状態を表します。確認したいときは、別のコマンドを挟まずに実行してください。

実行時にはSQLiteのDLLも使われる

今回の方法で作成した db_sample.exe は、通常、実行時にSQLiteのDLLを利用します。

MSYS2を C:\msys64 にインストールした場合、DLLは次の場所にあります。

C:\msys64\ucrt64\bin\libsqlite3-0.dll

MSYS2 UCRT64のターミナルでは、このディレクトリがPATHに含まれているため、DLLを見つけて利用できます。

一方、db_sample.exe だけを別の場所へコピーし、異なる環境から起動すると、必要なDLLが見つからず起動できないことがあります。

まずは教材どおり、コンパイルも実行もMSYS2 UCRT64のターミナルから行うようにしましょう。

books.db を開く場所に注意する

プログラムでは、データベースの場所を books.db という相対パスで指定しています。

この場合、基準になるのは、プログラムを実行したときの作業ディレクトリです。実行ファイルが置かれているディレクトリが、自動的に基準になるわけではありません。

今回の手順なら、次のファイルを開きます。

実行時の作業ディレクトリ指定したファイル名開くファイル
C:\c-db\chap03books.dbC:\c-db\chap03\books.db

たとえば、C:\c-db から chap03 内の実行ファイルを起動すると、プログラムは C:\c-db\books.db を開こうとします。

sqlite3_open は、指定したデータベースファイルが存在しなければ、新しく作成しようとします。そのため、作業ディレクトリを間違えても、別の場所に新しいデータベースが作られて成功する場合があります。

今回の実習では、次の順番で操作すると場所をそろえられます。

cd /c/c-db/chap03
./db_sample.exe

なお、接続成功のメッセージだけでは、books テーブルの存在や書籍の件数までは確認できません。このプログラムで確認しているのは、データベースを開いて閉じる処理です。

エラーが出たときは発生した段階を確認する

うまく動かないときは、最初に「実行ファイルを作る途中なのか」「実行ファイルを起動した後なのか」を確認しましょう。

同じSQLite関連のエラーでも、発生した段階によって原因が異なります。

段階メッセージや症状の例主に確認すること
ソースファイルの読み込みdb_sample.c が見つからない作業ディレクトリと保存先
コンパイルsqlite3.h: No such file or directorySQLite開発用ファイルのインストールと使用中のGCC
リンクundefined reference と sqlite3_open などが表示される-lsqlite3 の指定と位置
リンクcannot find -lsqlite3SQLiteライブラリのインストールと環境
プログラムの起動libsqlite3-0.dll が見つからないUCRT64から実行しているか
データベースを開く処理Failed to open database と表示されるデータベースのパスやアクセス権限

エラーメッセージの表現は、環境やバージョンによって多少異なります。

sqlite3.h が見つからない場合

まず、使用している環境とGCCを確認します。

echo "$MSYSTEM"
command -v gcc

UCRT64と /ucrt64/bin/gcc が表示されることを確認してください。

続いて、SQLiteのヘッダーファイルがあるか確認します。

ls /ucrt64/include/sqlite3.h

UCRT64用SQLiteが未インストールの場合は、第2章で使用したパッケージをインストールします。

pacman -S mingw-w64-ucrt-x86_64-sqlite3

インストール後、再びコンパイルしてください。

SQLiteの関数が見つからない場合

sqlite3_open や sqlite3_close に関する undefined reference が表示されたら、まずコンパイルコマンドを確認します。

-lsqlite3 を付け忘れていないか、末尾に指定しているかを見直しましょう。

gcc -std=c17 -Wall -Wextra db_sample.c -o db_sample.exe -lsqlite3

ソースコードに sqlite3.h を読み込む記述があっても、リンクの指定は別に必要です。

コンパイルに失敗した後は実行を待つ

一度コンパイルに成功した後でソースコードを変更し、次のコンパイルに失敗すると、以前作成した db_sample.exe が残っている場合があります。

その状態で実行すると、修正前のプログラムが動くことがあります。

ファイルが存在するかだけで判断せず、直前のコンパイルが成功したことを確認してから実行する習慣をつけましょう。

図3:エラーが起きた段階から確認する場所を探す

この図から分かること

エラーが発生した段階によって、確認する対象が変わります。

ヘッダーが見つからない問題、リンクの指定が足りない問題、DLLを読み込めない問題、データベースを開けない問題を分けて考えると、修正する場所を見つけやすくなります。

ソースコードを変更したら、保存して作り直す

今後、C言語からSQLを実行する処理を追加するときも、基本の作業は同じです。

  1. VS Codeでソースコードを編集する。
  2. ファイルを保存する。
  3. MSYS2 UCRT64でコンパイルする。
  4. エラーや警告を確認する。
  5. 作成した実行ファイルを実行する。

今回のコンパイルコマンドは、SQLiteを使うC言語プログラムの基本形になります。

gcc -std=c17 -Wall -Wextra db_sample.c -o db_sample.exe -lsqlite3

実行するコマンドはこちらです。

./db_sample.exe

データベースを開いて閉じるところまで動けば、次はその間にSQLを実行する処理を加えていけます。コマンドラインで学んだ書籍の登録・一覧表示・変更・削除を、少しずつC言語のプログラムへ移していきましょう。

Follow me!