C言語+MySQL入門|SQLエラーを表示する

C言語+MySQL入門|SQLエラーを表示する

前の記事では、mysql_affected_rows()を使い、SQLによって何行に影響したかを確認しました。

今回は、SQLの実行に失敗した場合に、エラーの内容を表示して原因を調べる方法を学びましょう。

SQLエラーには、文法の間違い、テーブル名の間違い、データの制約違反などがあります。失敗したことだけを表示するよりも、エラー番号やメッセージを表示したほうが、原因を見つけやすくなります。

この記事では、次の内容を解説します。

  • SQLの実行失敗を確認する方法
  • エラー番号、SQLSTATE、メッセージの表示
  • 文法ミスを調べる手順
  • テーブル名の間違いを調べる手順
  • CHECK制約に違反した値を調べる手順
  • SQLを修正して再実行する方法

学習用のプログラムで意図的にエラーを発生させ、表示された情報とSQLを見比べてみましょう。

エラーを表示すると原因を調べやすくなる

mysql_query()は、SQLの実行に成功すると0、失敗すると0以外を返します。

ただし、この戻り値だけでは、何が原因で失敗したのかは分かりません。

原因を調べるために、次の3つの関数を使います。

関数取得する情報戻り値の型
mysql_errno()エラー番号unsigned int
mysql_sqlstate()5文字のSQLSTATEconst char *
mysql_error()エラーの説明メッセージconst char *

mysql_errno()は数値のエラー番号、mysql_error()は説明メッセージを返します。mysql_sqlstate()は、エラーを分類する5文字の文字列を返します。

たとえば、次のような情報を表示できます。

Error number: 3819
SQLSTATE: HY000
Message: Check constraint 'chk_products_price' is violated.

この例では、chk_products_priceというCHECK制約に違反したことが分かります。

エラー番号で種類を確認し、メッセージに書かれた名前や内容を手がかりに原因を調べましょう。

図1:エラー番号とメッセージから原因を調べる

この図から分かること

SQLの実行失敗を確認した後で、エラー番号、SQLSTATE、メッセージを取得します。

これらを表示すると、文法の問題なのか、テーブルの指定なのか、登録する値の問題なのかを調べやすくなります。

mysql_query()の戻り値とエラー番号を区別する

mysql_query()の戻り値は、エラー番号そのものではありません。

たとえば、文法ミスの場合、次のようになることがあります。

情報値の例意味
mysql_query()の戻り値1SQLの実行に失敗した
mysql_errno()の戻り値1064SQLの構文エラー

mysql_query()が失敗時に必ず1を返すと決めつけず、0以外かどうかで判定してください。

具体的なエラー番号は、mysql_errno()で取得します。

今回確認する3種類のSQLエラー

今回のプログラムでは、実行するSQLを切り替えて、次のエラーを確認します。

test_caseの値試す内容SQLの問題
1文法ミスFROMをFORMと書いている
2テーブル名の間違いproductsをproductと書いている
3CHECK制約違反価格に負の値を指定している

最初の2つのDELETEには、WHERE 1 = 0を付けています。

この条件はどの行にも一致しないため、文法やテーブル名を正しく直した後も、商品の行は削除されません。

3つ目では、負の価格を持つ商品をINSERTしようとします。第3章で設定したchk_products_priceが有効なら、登録は拒否されます。

今回の実習は、MySQL Server 8.4と、第3章で作成したproductsテーブルを前提にしています。

SQLエラーを表示するプログラムを作成する

実行するSQLは、test_caseの値で選択します。

利用者の入力からSQLを組み立てる処理はなく、プログラム内に書いた固定SQLを使います。

固定SQLを実行し、エラー番号と説明を表示するプログラム

ファイル名: sql_error_check.c

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

int main(void)
{
    /*
     * 確認する内容を選択する。
     * 1:文法ミス
     * 2:テーブル名の間違い
     * 3:CHECK制約違反
     */
    const int test_case = 1;

    const char *sql = NULL;

    /* 選択した番号に対応する固定SQLを用意する */
    switch (test_case) {
        case 1:
            /* FROMを意図的にFORMと書いている */
            sql = "DELETE FORM products WHERE 1 = 0";
            break;

        case 2:
            /* productsを意図的にproductと書いている */
            sql = "DELETE FROM product WHERE 1 = 0";
            break;

        case 3:
            /* 価格を0以上にするCHECK制約に違反する */
            sql =
                "INSERT INTO products (product_name, price) "
                "VALUES ('エラー確認用商品', -100.00)";
            break;

        default:
            fprintf(stderr, "Invalid test case.\n");
            return EXIT_FAILURE;
    }

    /* 第3章で設定した接続情報を指定する */
    const char *host = "127.0.0.1";
    const char *user = "inventory_user";

    /* 実際に設定したパスワードに合わせる */
    const char *password = "InventoryPass_2026";

    const char *database = "inventory_db";
    unsigned int port = 3306;

    /* 接続を管理するための領域を初期化する */
    MYSQL *conn = mysql_init(NULL);

    if (conn == NULL) {
        fprintf(stderr, "mysql_init() failed.\n");
        return EXIT_FAILURE;
    }

    /* MySQLサーバーに接続する */
    if (mysql_real_connect(
            conn,
            host,
            user,
            password,
            database,
            port,
            NULL,
            0
        ) == NULL) {
        fprintf(
            stderr,
            "Connection failed: %s\n",
            mysql_error(conn)
        );

        mysql_close(conn);
        conn = NULL;

        return EXIT_FAILURE;
    }

    puts("Connected to MySQL Server.");

    /* 日本語を含むSQLを送るため、接続文字セットを設定する */
    if (mysql_set_character_set(conn, "utf8mb4") != 0) {
        fprintf(
            stderr,
            "Character set setup failed: %s\n",
            mysql_error(conn)
        );

        mysql_close(conn);
        conn = NULL;

        return EXIT_FAILURE;
    }

    puts("Connection character set: utf8mb4");

    /* どのSQLを実行するのかを表示する */
    printf("Test case: %d\n", test_case);
    printf("SQL: %s\n", sql);
    fflush(stdout);

    /* SQLを実行する */
    int query_result = mysql_query(conn, sql);

    printf("mysql_query() returned: %d\n", query_result);
    fflush(stdout);

    int exit_status = EXIT_SUCCESS;

    if (query_result != 0) {
        /*
         * 別のSQLを実行したり接続を閉じたりする前に、
         * エラー情報を取得して表示する。
         */
        unsigned int error_number = mysql_errno(conn);
        const char *sqlstate = mysql_sqlstate(conn);
        const char *error_message = mysql_error(conn);

        fprintf(stderr, "SQL execution failed.\n");
        fprintf(stderr, "Error number: %u\n", error_number);
        fprintf(stderr, "SQLSTATE: %s\n", sqlstate);
        fprintf(stderr, "Message: %s\n", error_message);

        exit_status = EXIT_FAILURE;
    } else {
        /* SQLに成功した場合だけ、影響を受けた行数を取得する */
        my_ulonglong affected_rows = mysql_affected_rows(conn);

        if (affected_rows == (my_ulonglong)-1) {
            fprintf(
                stderr,
                "Could not get affected rows: %s\n",
                mysql_error(conn)
            );

            exit_status = EXIT_FAILURE;
        } else {
            puts("SQL executed successfully.");

            printf(
                "Affected rows: %llu\n",
                (unsigned long long)affected_rows
            );
        }
    }

    /* 成功した場合も失敗した場合も、接続を終了する */
    mysql_close(conn);
    conn = NULL;

    puts("Connection closed.");

    return exit_status;
}

sql_error_check.cは、C:\c-mysql\chap05にUTF-8で保存してください。パスワードは、自分の環境に合わせて変更します。

プログラムのエラー表示を確認する

エラー番号は%uで表示する

mysql_errno()の戻り値はunsigned int型なので、表示には%uを使います。

mysql_query()の戻り値はint型なので、%dを使っています。

表示する情報書式指定子
mysql_query()の戻り値%d
エラー番号%u
SQLSTATE%s
エラーメッセージ%s

文字列のメッセージは、%sに渡して表示します。

エラーを表示してから接続を閉じる

エラー情報は、SQLが失敗した直後に取得しています。

その後でmysql_close()を呼び出すため、接続が有効なうちに必要な情報を表示できます。

mysql_error()とmysql_sqlstate()が返す文字列は、ライブラリが管理している情報です。自分でfree()せず、接続を閉じた後に使うことも避けましょう。

実行エラーの場合は行数の判定へ進まない

SQLが失敗した場合は、エラー情報を表示してEXIT_FAILUREで終了します。

mysql_affected_rows()による通常の行数の確認は、SQLの実行に成功した場合だけ行います。

前の記事で扱った行数0と、SQLの実行エラーを分けるための構成です。

図2:SQLのどの部分に問題があるかを確認する

この図から分かること

SQLエラーには、SQLの書き方に関する問題と、名前やデータの条件に関する問題があります。

表示されたメッセージに合わせて、確認する場所を絞り込んでいきましょう。

文法ミスのエラーを確認する

最初は、test_caseが1の状態で実行します。

このSQLでは、FROMをFORMと書いています。

DELETE FORM products WHERE 1 = 0;

コンパイルして実行する

MSYS2 UCRT64のターミナルで、次のコマンドを実行してください。

cd /c/c-mysql/chap05

gcc -std=c17 -Wall -Wextra -Wpedantic sql_error_check.c -o sql_error_check.exe \
  $(pkg-config --cflags --libs mysqlclient)

./sql_error_check.exe

文法ミスがある場合の実行結果の例

Connected to MySQL Server.
Connection character set: utf8mb4
Test case: 1
SQL: DELETE FORM products WHERE 1 = 0
mysql_query() returned: 1
SQL execution failed.
Error number: 1064
SQLSTATE: 42000
Message: You have an error in your SQL syntax; check the manual that corresponds to your MySQL server version for the right syntax to use near 'FORM products WHERE 1 = 0' at line 1
Connection closed.

エラー番号1064は、SQLの構文エラーを表します。

メッセージのnear以降には、問題を検出した付近のSQLが表示されています。この例では、FORMの周辺を確認すると、FROMの書き間違いに気づけます。

なお、at line 1は、サーバーへ送ったSQL内の行番号です。Cのソースコードの行番号ではありません。

エラーメッセージの細かな表現は、サーバーのバージョンや設定によって異なる場合があります。

文法を修正して再実行する

sql_error_check.cを開き、case 1のSQLにあるFORMをFROMへ変更します。

修正後に送信するSQLは、次の内容です。

DELETE FROM products WHERE 1 = 0;

ファイルを保存し、再コンパイルしてから実行してください。

gcc -std=c17 -Wall -Wextra -Wpedantic sql_error_check.c -o sql_error_check.exe \
  $(pkg-config --cflags --libs mysqlclient)

./sql_error_check.exe

修正後の実行結果の例です。

Connected to MySQL Server.
Connection character set: utf8mb4
Test case: 1
SQL: DELETE FROM products WHERE 1 = 0
mysql_query() returned: 0
SQL executed successfully.
Affected rows: 0
Connection closed.

SQLの実行に成功しました。

WHERE 1 = 0はどの行にも一致しないため、削除された行数は0です。この0は、SQLエラーを意味していません。

テーブル名の間違いを確認する

次は、productsをproductと書いたSQLを試します。

DELETE FROM product WHERE 1 = 0;

実行するSQLを切り替える

sql_error_check.cを開き、test_caseの値を2に変更して保存します。

case 2のSQLは、まだ修正せずに実行してください。

gcc -std=c17 -Wall -Wextra -Wpedantic sql_error_check.c -o sql_error_check.exe \
  $(pkg-config --cflags --libs mysqlclient)

./sql_error_check.exe

テーブル名を間違えた場合の実行結果の例

第3章では、inventory_userに対して、productsとstock_historyの操作権限をテーブル単位で付与しました。

その設定では、間違えたテーブル名に対する権限確認で、次のようなエラーが表示される場合があります。

Connected to MySQL Server.
Connection character set: utf8mb4
Test case: 2
SQL: DELETE FROM product WHERE 1 = 0
mysql_query() returned: 1
SQL execution failed.
Error number: 1142
SQLSTATE: 42000
Message: DELETE command denied to user 'inventory_user'@'localhost' for table 'product'
Connection closed.

これは、1142になった場合の例です。ユーザーのホスト表記は、接続環境によって異なります。

権限の設定によっては、1146とSQLSTATEの42S02が表示され、テーブルが存在しないことを示すメッセージになる場合もあります。

エラー番号表していること
1142指定したテーブルへの操作権限がない
1146指定したテーブルが存在しない

これらは、それぞれMySQLで定義されているエラーです。

テーブル名を間違えた場合に、必ず1146になるとは限りません。権限エラーが表示されても、まずSQLに書いたテーブル名を確認しましょう。

MySQLクライアントでテーブル名を確認する

Windowsのコマンドプロンプトで、MySQLクライアントに接続します。すでに接続している場合は、その画面を使ってください。

chcp 65001
cd /d "C:\Program Files\MySQL\MySQL Server 8.4\bin"
mysql --protocol=TCP --default-character-set=utf8mb4 -h 127.0.0.1 -P 3306 -u inventory_user -p

インストール先が異なる場合は、binフォルダーのパスを変更します。パスワードには、inventory_userに設定したものを入力してください。

接続後、次のSQLを実行します。

USE inventory_db;

SHOW TABLES;

表示内容を表に整理すると、次のようになります。

+------------------------+
| Tables_in_inventory_db |
+------------------------+
| products               |
| stock_history          |
+------------------------+
2 rows in set (0.00 sec)

正しいテーブル名はproductsです。

今回のSQLはproductとなっているため、名前を修正します。間違えた名前に対して権限を追加する必要はありません。

テーブル名を修正して再実行する

sql_error_check.cのcase 2にあるproductを、productsへ変更します。

修正後のSQLです。

DELETE FROM products WHERE 1 = 0;

test_caseは2のままにして保存し、再コンパイルして実行します。

gcc -std=c17 -Wall -Wextra -Wpedantic sql_error_check.c -o sql_error_check.exe \
  $(pkg-config --cflags --libs mysqlclient)

./sql_error_check.exe

修正後の実行結果の例です。

Connected to MySQL Server.
Connection character set: utf8mb4
Test case: 2
SQL: DELETE FROM products WHERE 1 = 0
mysql_query() returned: 0
SQL executed successfully.
Affected rows: 0
Connection closed.

正しいテーブル名に直すと、SQLの実行に成功しました。

CHECK制約に違反する値を確認する

最後に、価格に負の値を指定してみましょう。

第3章では、productsテーブルに次のCHECK制約を設定しました。

制約名条件
chk_products_pricepriceが0以上
chk_products_stockstockが0以上

CHECK制約が有効な場合、条件に違反する値を持つ行の登録や変更は拒否されます。

今回試すSQLは、次のとおりです。

INSERT INTO products (product_name, price)
VALUES ('エラー確認用商品', -100.00);

SQLの文法は正しくても、価格が0以上という条件を満たしていません。

実行前の商品件数を確認する

MySQLクライアントで、次のSQLを実行します。

USE inventory_db;

SELECT COUNT(*) AS error_test_count
FROM products
WHERE product_name = 'エラー確認用商品';

まだ同じ名前の商品を登録していなければ、結果は次のようになります。

+------------------+
| error_test_count |
+------------------+
|                0 |
+------------------+
1 row in set (0.01 sec)

すでに同じ名前の商品がある場合は、表示された件数を控えてください。実行前後で件数が変わったかを確認します。

制約違反のSQLを実行する

sql_error_check.cを開き、test_caseの値を3に変更して保存します。

case 3の価格は、-100.00のままにしてください。

gcc -std=c17 -Wall -Wextra -Wpedantic sql_error_check.c -o sql_error_check.exe \
  $(pkg-config --cflags --libs mysqlclient)

./sql_error_check.exe

制約違反がある場合の実行結果の例

Connected to MySQL Server.
Connection character set: utf8mb4
Test case: 3
SQL: INSERT INTO products (product_name, price) VALUES ('エラー確認用商品', -100.00)
mysql_query() returned: 1
SQL execution failed.
Error number: 3819
SQLSTATE: HY000
Message: Check constraint 'chk_products_price' is violated.
Connection closed.

3819は、CHECK制約に違反したことを表すエラー番号です。

メッセージには、違反した制約名であるchk_products_priceが表示されています。価格の条件を確認すると、-100.00が原因だと分かります。

登録されていないことを確認する

MySQLクライアントで、実行前と同じSQLを実行します。

SELECT COUNT(*) AS error_test_count
FROM products
WHERE product_name = 'エラー確認用商品';

実行前の件数が0だった場合、結果は次のようになります。

+------------------+
| error_test_count |
+------------------+
|                0 |
+------------------+
1 row in set (0.00 sec)

CHECK制約によって登録が拒否されたため、商品は追加されていません。

なお、INSERTに失敗しても、AUTO_INCREMENTの番号が消費される場合があります。商品IDに欠番ができても、その番号の商品が登録されているとは限りません。

価格を修正して登録する

sql_error_check.cのcase 3にある価格を、-100.00から100.00へ変更します。

修正後のSQLです。

INSERT INTO products (product_name, price)
VALUES ('エラー確認用商品', 100.00);

test_caseは3のままにして保存し、再コンパイルして実行してください。

gcc -std=c17 -Wall -Wextra -Wpedantic sql_error_check.c -o sql_error_check.exe \
  $(pkg-config --cflags --libs mysqlclient)

./sql_error_check.exe

修正後の実行結果の例です。

Connected to MySQL Server.
Connection character set: utf8mb4
Test case: 3
SQL: INSERT INTO products (product_name, price) VALUES ('エラー確認用商品', 100.00)
mysql_query() returned: 0
SQL executed successfully.
Affected rows: 1
Connection closed.

価格が制約を満たしたため、商品を1件登録できました。

この状態でプログラムを繰り返し実行すると、そのたびに商品が追加されます。修正後の登録確認は、まず1回だけ実行しましょう。

登録された商品の値を確認する

MySQLクライアントで、次のSQLを実行します。

SELECT product_name, price, stock
FROM products
WHERE product_name = 'エラー確認用商品';

実行前に同じ名前の商品がなかった場合、結果は次のようになります。

+--------------------------+--------+-------+
| product_name             | price  | stock |
+--------------------------+--------+-------+
| エラー確認用商品         | 100.00 |     0 |
+--------------------------+--------+-------+
1 row in set (0.01 sec)

価格は100.00で登録され、INSERTで指定しなかった在庫数には、既定値の0が入りました。

制約違反を直すときは、制約を外すのではなく、まず登録する値が正しいか確認することが大切です。

図3:エラーを確認し、SQLを修正して再実行する

この図から分かること

エラーを修正したら、ファイルの保存、再コンパイル、再実行まで行います。

SQLの実行に成功したことを確認した後、必要に応じて商品の値や件数も調べると、修正結果を確かめられます。

エラーメッセージを読むときの着眼点

英語のメッセージを最初からすべて訳そうとしなくても、手がかりになる部分から確認できます。

メッセージに現れる表現確認すること
SQL syntaxSQLの文法や単語の並び
nearエラーを検出した付近のSQL
Table指定したデータベース名やテーブル名
command denied操作権限と、指定した名前
Check constraint制約名と、登録・変更する値
foreign key constraint商品と履歴などの参照関係

前の記事で扱った、履歴のある商品の削除も、外部キー制約に違反するとSQLエラーになります。

その場合も、メッセージに現れるテーブル名や制約名を確認し、どの関係を守るために拒否されたのかを調べましょう。

エラー情報は失敗した直後に表示する

エラー情報は、SQLが失敗した直後に取得することが大切です。

別のSQLや、エラー状態を更新する処理を先に実行すると、調べたかったエラーの情報が変わってしまう可能性があります。

今回のプログラムでは、次の順序にしています。

  1. mysql_query()でSQLを実行する
  2. 戻り値が0以外か確認する
  3. エラー番号、SQLSTATE、メッセージを取得する
  4. エラー情報を表示する
  5. 接続を閉じる

また、SQLSTATEだけでは原因を細かく区別できない場合があります。今回の例でも、文法ミスと権限エラーはどちらも42000になりました。

エラー番号とメッセージを合わせて確認してくださいね。

ソースを直したら実行ファイルも作り直す

Cプログラムでは、sql_error_check.cを修正しただけでは、sql_error_check.exeの内容は変わりません。

古い実行ファイルを動かすと、修正前のSQLが再び送信されます。

修正後も同じエラーが出る場合は、次の点を確認しましょう。

  • 修正したソースファイルを保存したか
  • コンパイルに成功したか
  • 作り直した実行ファイルを実行しているか
  • 画面のSQL表示が、修正した内容になっているか

今回のプログラムは、実行するSQLも表示します。画面に出たSQLとソースコードを見比べると、修正が反映されているかを確認できます。

次の記事では、SQLの実行とエラー表示を関数に分け、同じ処理を繰り返し書く部分を減らしていきましょう。

Follow me!