C言語DB入門|書籍を一覧表示する

C言語DB入門|書籍を一覧表示する

前の記事では、タイトルと著者名を入力し、SQLiteへ書籍を登録するプログラムを作成しました。

この記事では、そのデータをC言語から読み取り、ID・タイトル・著者名をコンソールへ一覧表示する機能を作成します。

今回取り組むのは、CRUDのReadに当たる処理です。SELECTの結果を1行ずつ受け取り、登録されている書籍を順番に表示していきましょう。

  • SELECTで書籍データを取得する
  • 複数の行を順番に読み取る
  • 各行のID・タイトル・著者名を取り出す
  • 表示した件数を数える
  • 書籍が0件の場合や、取得に失敗した場合に対応する

今回も、単独で実行できるプログラムとして作成します。メニュー形式への組み込みは、各機能を学んだ後で行います。

一覧表示は「取得」と「表示」を組み合わせる

sqlite3コマンドでは、SELECTを入力すると、取得結果が画面に表示されました。

C言語からSQLiteを利用する場合は、データを取得する処理に加えて、そのデータを画面へ表示する処理も自分で書きます。

処理使用するもの
SQL文を準備するsqlite3_prepare_v2
結果を1行ずつ取得するsqlite3_step
現在の行から列の値を取り出すsqlite3_column_int64、sqlite3_column_text
取り出した値を表示するprintf
ステートメントを解放するsqlite3_finalize

SELECTを準備しただけでは、一覧は表示されません。

1行取得し、その行の値を取り出して表示する処理を繰り返すことが、今回の中心になります。

図1:SQLiteから読み取った書籍をC言語で表示する

この図から分かること

SQLiteは、SELECTの結果をC言語プログラムへ渡します。

C言語プログラムは、その結果から必要な値を取り出し、printfで画面に表示します。読み取ったことで、保存されている書籍が削除されることはありません。

前の記事と同じデータベースを使用する

作業場所は、前の記事と同じC:\c-db\chap04です。

MSYS2 UCRT64を起動し、次のコマンドで移動してください。

cd /c/c-db/chap04

今回使用するファイルは、次のとおりです。

ファイル名役割
list_books.c書籍を一覧表示するソースファイル
list_books.exeコンパイルして作成する実行ファイル
books.db前の記事で書籍を登録したデータベースファイル

add_book.exeとlist_books.exeが、同じディレクトリのbooks.dbを使用する形になります。

前の記事の例に沿って2件登録していれば、次の書籍を表示できます。

idtitleauthor
1はじめてのC言語佐藤花子
2SQLite入門田中太郎

実際の表示内容は、自分が登録した書籍によって変わります。

一覧表示に使うSELECTを確認する

今回使用するSQLは、次のとおりです。

SELECT id, title, author
FROM books
ORDER BY id;

booksテーブルから、id・title・authorの3列を取得します。

SQLの部分意味
SELECT id, title, author取得する列と、その順番を指定する
FROM books取得元のテーブルを指定する
ORDER BY idIDの昇順で並べる

ORDER BYを指定しない場合、結果の並び順は保証されません。毎回IDの小さい順に表示するため、明示的に指定します。

また、今回は検索条件などの入力値がないため、sqlite3_bind_textなどによる値の設定は不要です。

書籍を一覧表示するプログラムを作成する

VS Codeでlist_books.cを作成し、UTF-8で保存してください。

前の記事と同じように、起動時にデータベースとテーブルを準備します。すでにbooksテーブルがある場合は、保存されているデータをそのまま使用します。

保存されている書籍をID順に一覧表示するプログラム

ファイル名: list_books.c

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

static int initialize_database(sqlite3 *db)
{
    const char *sql =
        "CREATE TABLE IF NOT EXISTS books ("
        "id INTEGER PRIMARY KEY AUTOINCREMENT,"
        "title TEXT NOT NULL,"
        "author TEXT NOT NULL"
        ");";

    int rc = sqlite3_exec(db, sql, NULL, NULL, NULL);

    if (rc != SQLITE_OK) {
        fprintf(stderr, "テーブルの準備に失敗しました:%s\n",
                sqlite3_errmsg(db));
        return 0;
    }

    return 1;
}

static int list_books(sqlite3 *db)
{
    const char *sql =
        "SELECT id, title, author FROM books ORDER BY id;";

    sqlite3_stmt *stmt = NULL;
    size_t count = 0;

    int rc = sqlite3_prepare_v2(db, sql, -1, &stmt, NULL);

    if (rc != SQLITE_OK) {
        fprintf(stderr, "SQLの準備に失敗しました:%s\n",
                sqlite3_errmsg(db));
        sqlite3_finalize(stmt);
        return 0;
    }

    printf("書籍一覧\n");

    while ((rc = sqlite3_step(stmt)) == SQLITE_ROW) {
        sqlite3_int64 id = sqlite3_column_int64(stmt, 0);

        const unsigned char *title = sqlite3_column_text(stmt, 1);

        if (title == NULL) {
            fprintf(stderr, "タイトルを取得できませんでした。\n");
            sqlite3_finalize(stmt);
            return 0;
        }

        const unsigned char *author = sqlite3_column_text(stmt, 2);

        if (author == NULL) {
            fprintf(stderr, "著者名を取得できませんでした。\n");
            sqlite3_finalize(stmt);
            return 0;
        }

        if (count == 0) {
            printf("ID | タイトル | 著者名\n");
        }

        printf("%lld | %s | %s\n",
               (long long)id,
               (const char *)title,
               (const char *)author);

        count++;
    }

    if (rc != SQLITE_DONE) {
        fprintf(stderr, "一覧の取得に失敗しました:%s\n",
                sqlite3_errmsg(db));
        sqlite3_finalize(stmt);
        return 0;
    }

    rc = sqlite3_finalize(stmt);
    stmt = NULL;

    if (rc != SQLITE_OK) {
        fprintf(stderr, "ステートメントの解放に失敗しました:%s\n",
                sqlite3_errmsg(db));
        return 0;
    }

    if (count == 0) {
        printf("書籍はまだ登録されていません。\n");
    } else {
        printf("\n%zu件の書籍があります。\n", count);
    }

    return 1;
}

int main(void)
{
    sqlite3 *db = NULL;
    int success = 0;

    int rc = sqlite3_open("books.db", &db);

    if (rc != SQLITE_OK) {
        fprintf(stderr, "データベースを開けませんでした。\n");

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

        return EXIT_FAILURE;
    }

    if (initialize_database(db)) {
        success = list_books(db);
    }

    rc = sqlite3_close(db);

    if (rc != SQLITE_OK) {
        fprintf(stderr, "データベース接続を閉じられませんでした:%s\n",
                sqlite3_errmsg(db));
        return EXIT_FAILURE;
    }

    return success ? EXIT_SUCCESS : EXIT_FAILURE;
}

コンパイルして一覧を表示する

ソースファイルを保存したら、MSYS2 UCRT64でコンパイルします。

短いコマンドはこちらです。

gcc list_books.c -o list_books.exe -lsqlite3

C17と警告オプションを指定する場合は、次のコマンドを使用します。

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

どちらか一方でコンパイルし、成功したら実行してください。

./list_books.exe

実行結果の例

前の記事で2件登録した場合の例です。

書籍一覧
ID | タイトル | 著者名
1 | はじめてのC言語 | 佐藤花子
2 | SQLite入門 | 田中太郎

2件の書籍があります。

今回は、メニュー番号などを入力する必要はありません。起動すると一覧を表示し、その後で終了します。

表示位置を細かくそろえる処理は入れず、各項目を縦棒で区切っています。日本語の表示幅を調整する前に、まず取得した値を正しく表示することを目指しましょう。

プログラム全体の役割分担

プログラムは、3つの関数で構成しています。

関数名役割
initialize_databasebooksテーブルがなければ作成する
list_booksSELECTの結果を1行ずつ読み取り、一覧を表示する
mainデータベースを開き、各処理を呼び出して接続を閉じる

前の記事との主な違いは、add_bookの代わりにlist_booksを呼び出している点です。

データベース接続の管理はmainに任せ、一覧表示に必要な処理はlist_booksにまとめています。

sqlite3_stepを繰り返して複数行を取得する

一覧表示で最も大切なのが、sqlite3_stepの繰り返しです。

前の記事のINSERTでは、sqlite3_stepを実行してSQLITE_DONEが返ることを確認しました。

sqlite3_step(stmt) は、準備済みSQL(prepared statement)を実際に1ステップ実行する関数です。

SELECTでは、取得できる行がある間はSQLITE_ROWが返ります。すべての行を読み終えると、SQLITE_DONEが返ります。

戻り値SELECTでの意味プログラムの動作
SQLITE_ROW1行分の結果を取得できた列の値を取り出して表示する
SQLITE_DONE結果を最後まで取得した繰り返しを終了する
その他の値エラーが発生した原因を表示して後片付けする

2件の書籍がある場合、sqlite3_stepの呼び出しは次のように進みます。

呼び出し戻り値行う処理
1回目SQLITE_ROW1件目を表示する
2回目SQLITE_ROW2件目を表示する
3回目SQLITE_DONE全件取得できたことを確認する

2件を表示する場合でも、取得の終了を確かめるために、最後にもう1回呼び出す点がポイントです。

whileの条件式で行っていること

プログラムのwhileの条件では、次の処理をまとめて行っています。

  1. sqlite3_stepを呼び出す。
  2. 戻り値をrcへ代入する。
  3. rcがSQLITE_ROWか比較する。
  4. SQLITE_ROWなら、whileの中を実行する。

条件式にある=は代入、==は比較です。

また、ループを抜けた時点のrcを残しているので、後から「正常終了だったのか」「エラーだったのか」を確認できます。

図2:1行ずつ取得し、読み終わるまで繰り返す

この図から分かること

sqlite3_stepを呼び出し、SQLITE_ROWが返るたびに、その行を処理します。

ループを抜けただけでは、正常に読み終えたとは限りません。最後の戻り値がSQLITE_DONEであることまで確認します。

列番号を指定して値を取り出す

1行を取得したら、その行からID・タイトル・著者名を取り出します。

ここで指定する列番号は、SELECTに書いた列の順番に対応します。

列番号SELECTで指定した列使用する関数
0idsqlite3_column_int64
1titlesqlite3_column_text
2authorsqlite3_column_text

列番号は0から始まります。

前の記事で使用した、値をバインドする位置の番号は1から始まりました。よく似ていますが、開始番号が異なります。

操作番号の始まり
sqlite3_bind_textで疑問符に値を設定する1から
sqlite3_column_textなどで結果の列を読む0から

SELECTに書く列の順番を変更した場合は、値を取得する側の列番号も対応させる必要があります。

IDは整数として取得する

IDにはsqlite3_column_int64を使い、sqlite3_int64型の変数で受け取っています。

SQLiteのINTEGER PRIMARY KEYで扱うIDに合わせ、64ビットの整数として取得するためです。

表示時にはlong longへキャストし、printfの%lldを使用しています。

記述役割
sqlite3_column_int64列の値を64ビット整数として取得する
sqlite3_int64取得したIDを保存する型
(long long)idprintfへ渡す型を明示する
%lldlong longの整数を表示する

一覧に表示するIDは、データベースに保存された値です。画面上の表示順を使って、新しい番号を付けているわけではありません。

タイトルと著者名は文字列として取得する

文字列の取得にはsqlite3_column_textを使います。

戻り値はconst unsigned char *型なので、プログラムでも同じ型で受け取っています。取得される文字列はUTF-8で、末尾にナル文字が付いています。

printfへ渡すときにはconst char *へキャストし、%sで表示します。

このキャストは、文字コードを変換する処理ではありません。printfへ渡すポインターの型を合わせています。

NULLを確認してから表示する

プログラムでは、titleとauthorがNULLでないことを確認しています。

今回のテーブルではtitleとauthorをNOT NULLにしていますが、文字列の取得時にメモリ不足が発生した場合などは、NULLが返る可能性があります。

NULLをそのまま%sへ渡さず、取得できなかったことを表示して処理を終了する構成です。

取得した文字列は、その行を処理している間に使う

sqlite3_column_textから受け取るのは、SQLiteが管理している文字列へのポインターです。

今回のプログラムでは、値を取得したらすぐにprintfで表示し、その後で次のsqlite3_stepを呼び出します。

次の行へ進んだ後や、sqlite3_finalizeでステートメントを解放した後に、以前のポインターを使い続けてはいけません。後から使いたい場合は、有効なうちに自分で用意した領域へコピーします。

また、このポインターをfreeやsqlite3_freeで解放する必要はありません。

図3:現在の行から3つの列を取り出す

この図から分かること

SQLITE_ROWが返っている間は、現在の行の各列を読み取れます。

SELECTで指定した順に、0番目がID、1番目がタイトル、2番目が著者名です。必要な値を取り出して表示してから、次の行へ進みます。

表示した件数を数える

プログラムでは、countを0で初期化し、1行表示するたびに1増やしています。

すべての行を正常に取得できたら、countを表示します。

表示した行数countの値
まだ表示していない0
1行表示した1
2行表示した2

countにはsize_t型を使用しているため、printfでは%zuで表示しています。

今回は全件を取得しているので、正常終了時のcountが一覧の件数になります。件数を表示するためだけに、別のCOUNTを実行する必要はありません。

書籍が0件の場合も正常な結果

書籍がまだ登録されていない場合、最初のsqlite3_stepでSQLITE_DONEが返ります。

whileの中は一度も実行されず、countは0のままです。

書籍が0件の場合の実行結果の例

書籍一覧
書籍はまだ登録されていません。

0件は、SQLの実行エラーではありません。取得処理が正常に完了し、表示対象がなかった状態です。

状態意味
countが0でSQLITE_DONE正常に取得できたが、書籍がなかった
SQLITE_DONE以外でループを終了取得中にエラーが発生した

この2つを分けて扱うことで、利用者へ正しい状況を伝えられます。

後片付けは取得が終わってから行う

一覧の取得が終わったら、sqlite3_finalizeでステートメントを解放します。

その後、mainへ戻り、sqlite3_closeでデータベース接続を閉じます。

  1. SELECTの結果を最後まで取得する。
  2. sqlite3_finalizeでステートメントを解放する。
  3. 件数または未登録のメッセージを表示する。
  4. mainへ戻る。
  5. sqlite3_closeで接続を閉じる。

取得中にエラーが発生した場合も、ステートメントを解放してから戻ります。SQLite公式ドキュメント:sqlite3_finalize

今回のSELECTは書籍の内容を変更しません。繰り返し実行しても、一覧表示によって書籍が増えたり減ったりすることはありません。

登録した書籍が表示されないときは

前の記事で登録したはずなのに0件と表示された場合は、まず作業ディレクトリを確認しましょう。

pwd

今回の実習では、次の場所になっていることを確認します。

/c/c-db/chap04

books.dbを相対パスで指定しているため、基準になるのは実行時の作業ディレクトリです。

このプログラムは、データベースやテーブルがなければ作成する構成です。そのため、別の場所から起動すると、そこに新しいbooks.dbを作成し、0件と表示する場合があります。

確認すること確認する理由
chap04で実行しているか登録時と同じbooks.dbを開くため
登録時に成功メッセージが出たか入力エラーなどで登録されていない可能性があるため
ソースを保存してコンパイルしたか修正後のプログラムを実行するため

また、取得中にエラーが発生した場合は、それまでに一部の行が表示されていることもあります。行が表示されたかだけでなく、エラーメッセージが出ていないか、最後まで取得できたかも確認してください。

登録と一覧表示を組み合わせて使う

ここまでで、書籍を登録するadd_book.exeと、一覧を表示するlist_books.exeがそろいました。

同じchap04のディレクトリで、次の順番に実行できます。

  1. add_book.exeを実行して、新しい書籍を登録する。
  2. list_books.exeを実行する。
  3. 登録した書籍が一覧に追加されていることを確認する。

登録後に一覧表示のソースコードを変更したり、再コンパイルしたりする必要はありません。list_books.exeは、実行するたびにデータベースから書籍を読み取ります。

次の記事では、一覧に表示されたIDを使い、登録済みのタイトルや著者名を変更する機能を作成していきましょう。

Follow me!