QSqlDriver Class

メンバ関数のドキュメント

[explicit] QSqlDriver::QSqlDriver(QObject *parent = nullptr)

指定されたparent を使用して、新しいドライバーを作成します。

[virtual noexcept] QSqlDriver::~QSqlDriver()

オブジェクトを破棄し、割り当てられていたリソースをすべて解放します。

[virtual] bool QSqlDriver::beginTransaction()

この関数は、トランザクションを開始するために呼び出されます。成功した場合は true を返し、そうでない場合は false を返します。デフォルトの実装では何も行わず、false を返します。

commitTransaction() およびrollbackTransaction()も参照してください 。

[pure virtual] void QSqlDriver::close()

派生クラスは、データベース接続を閉じるために、この純粋仮想関数を再実装する必要があります。成功した場合は true を、失敗した場合は false を返します。

open() およびsetOpen()も参照してください 。

[virtual] bool QSqlDriver::commitTransaction()

この関数は、トランザクションをコミットするために呼び出されます。成功した場合は true を返し、そうでない場合は false を返します。デフォルトの実装では何も行わず、false を返します。

beginTransaction() およびrollbackTransaction()も参照してください 。

[since 6.9] QString QSqlDriver::connectionName() const

QSqlDatabase::addDatabase() によって作成されたドライバのデータベース接続名を返します

この関数は Qt 6.9 で導入されました。

[pure virtual] QSqlResult *QSqlDriver::createResult() const

データベース上に空のSQL結果を作成します。派生クラスはこの関数を再実装し、呼び出し元にそのデータベースに適したQSqlResult オブジェクトを返さなければなりません。

[virtual] QString QSqlDriver::escapeIdentifier(const QString &identifier, QSqlDriver::IdentifierType type) const

データベースのルールに従ってエスケープされたidentifier を返します。identifier は、type の設定に応じて、テーブル名またはフィールド名のいずれかになります。

デフォルトの実装では何も行われません。

isIdentifierEscaped()も参照してください 。

[virtual] QString QSqlDriver::formatValue(const QSqlField &field, bool trimStrings = false) const

データベースのfield 値を表す文字列を返します。これは、例えばINSERT文やUPDATE文を作成する際に使用されます。

デフォルトの実装では、以下の規則に従って文字列としてフォーマットされた値を返します。

• field が文字データの場合、値は単一引用符で囲まれて返されます。これは多くのSQLデータベースに適した形式です。埋め込まれた単一引用符はエスケープされます（2つの単一引用符に置き換えられます）。trimStrings がtrueの場合（デフォルトはfalse）、フィールドの末尾の空白はすべて削除されます。
• field が日付/時刻データの場合、値はISO形式でフォーマットされ、一重引用符で囲まれます。日付/時刻データが無効な場合は、「NULL」が返されます。
• field がbytearray データであり、かつドライバがバイナリフィールドを編集できる場合、その値は16進数文字列としてフォーマットされます。
• その他のフィールド型の場合、その値に対して toString() が呼び出され、その結果が返されます。

QVariant::toString()も参照してください 。

[virtual] QVariant QSqlDriver::handle() const

QVariant でラップされた低レベルのデータベースハンドルを返します。ハンドルが存在しない場合は、無効なバリアントを返します。

ここで返されるハンドルはデータベースに依存するため、アクセスする前にバリアントの型名を照会する必要があります。

この例は、sqlite への接続のハンドルを取得します:

QSqlDatabase db = QSqlDatabase::database();
QVariant v = db.driver()->handle();
if (v.isValid() && (qstrcmp(v.typeName(), "sqlite3*") == 0)) {
    // v.data() returns a pointer to the handle
    sqlite3 *handle = *static_cast<sqlite3 **>(v.data());
    if (handle) {
        // ...
    }
}

次のスニペットは、PostgreSQL または MySQL への接続ハンドルを返します：

if (qstrcmp(v.typeName(), "PGconn*") == 0) {
    PGconn *handle = *static_cast<PGconn **>(v.data());
    if (handle) {
        // ...
    }
}

if (qstrcmp(v.typeName(), "MYSQL*") == 0) {
    MYSQL *handle = *static_cast<MYSQL **>(v.data());
    if (handle) {
        // ...
    }
}

QSqlResult::handle()も参照してください 。

[pure virtual] bool QSqlDriver::hasFeature(QSqlDriver::DriverFeature feature) const

ドライバが機能feature をサポートしている場合はtrue を返し、そうでない場合はfalse を返します。

一部のデータベースでは、これを判定する前に `open()` を実行する必要があることに注意してください。

DriverFeatureも参照してください 。

[virtual] bool QSqlDriver::isIdentifierEscaped(const QString &identifier, QSqlDriver::IdentifierType type) const

identifier がデータベースのルールに従ってエスケープされているかどうかを返します。identifier は、type に応じて、テーブル名またはフィールド名のいずれかになります。

QSqlDriver のサブクラスで独自の実装を提供したい場合は、この関数を再実装してください。

stripDelimiters() およびescapeIdentifier()も参照してください 。

[virtual] bool QSqlDriver::isOpen() const

データベース接続が開かれている場合は `true ` を返し、そうでない場合は `false` を返します。

bool QSqlDriver::isOpenError() const

データベース接続の確立にエラーが発生した場合は `true ` を返し、それ以外の場合は `false` を返します。

QSqlError QSqlDriver::lastError() const

データベースで最後に発生したエラーに関する情報を含む `QSqlError ` オブジェクトを返します。

setLastError()も参照してください 。

[virtual, since 6.0] int QSqlDriver::maximumIdentifierLength(QSqlDriver::IdentifierType type) const

データベースの設定に基づき、識別子 `type ` の最大長を返します。データベースに最大長の制限がない場合は、デフォルトで `INT_MAX` を返します。

この関数は Qt 6.0 で導入されました。

[signal] void QSqlDriver::notification(const QString &name, QSqlDriver::NotificationSource source, const QVariant &payload)

このシグナルは、データベースがドライバがサブスクライブしているイベント通知を送信した際に発せられます。name はイベント通知を識別し、source はシグナルの発生源を示し、payload には通知とともにオプションで送信される追加データが格納されます。

subscribeToNotification()も参照してください 。

QSql::NumericalPrecisionPolicy QSqlDriver::numericalPrecisionPolicy() const

numericalPrecisionPolicy を返します。

関連項目： setNumericalPrecisionPolicy()。

[pure virtual] bool QSqlDriver::open(const QString &db, const QString &user = QString(), const QString &password = QString(), const QString &host = QString(), int port = -1, const QString &options = QString())

派生クラスは、この純粋仮想関数を再実装し、データベースdb に対して、ユーザー名user 、パスワードpassword 、ホストhost 、ポートport 、および接続オプションoptions を使用してデータベース接続を確立する必要があります。

この関数は、成功した場合は true を、失敗した場合は false を返す必要があります。

setOpen()も参照してください 。

[virtual] QSqlIndex QSqlDriver::primaryIndex(const QString &tableName) const

テーブル `tableName` の主キーを返します。テーブルに主キーがない場合は、空の `QSqlIndex ` を返します。デフォルトの実装では、空のインデックスが返されます。

[virtual] QSqlRecord QSqlDriver::record(const QString &tableName) const

テーブル `tableName` のフィールド名が入った `QSqlRecord ` を返します。そのようなテーブルが存在しない場合は、空のレコードが返されます。デフォルトの実装では、空のレコードが返されます。

[virtual] bool QSqlDriver::rollbackTransaction()

この関数は、トランザクションをロールバックするために呼び出されます。成功した場合は true を返し、そうでない場合は false を返します。デフォルトの実装では何も行わず、false を返します。

beginTransaction() およびcommitTransaction()も参照してください 。

[virtual protected] void QSqlDriver::setLastError(const QSqlError &error)

この関数は、データベースで発生した直近のエラー（error ）の値を設定するために使用されます。

lastError()も参照してください 。

void QSqlDriver::setNumericalPrecisionPolicy(QSql::NumericalPrecisionPolicy precisionPolicy)

numericalPrecisionPolicy をprecisionPolicy に設定します。

numericalPrecisionPolicy()も参照してください 。

[virtual protected] void QSqlDriver::setOpen(bool open)

この関数は、データベースのオープン状態をopen に設定します。派生クラスはこの関数を使用して、open()のステータスを報告することができます。

open() およびsetOpenError()も参照してください 。

[virtual protected] void QSqlDriver::setOpenError(bool error)

この関数は、データベースのオープン状態をerror に設定します。派生クラスはこの関数を使用して、open()のステータスを報告することができます。なお、error がtrueの場合、データベースのオープン状態はclosedに設定されます（つまり、isOpen()はfalse を返します）。

isOpenError()、open()、およびsetOpen()も参照してください 。

[virtual] QString QSqlDriver::sqlStatement(QSqlDriver::StatementType type, const QString &tableName, const QSqlRecord &rec, bool preparedStatement) const

rec の値を指定して、tableName テーブルに対するtype 型のSQL文を返します。preparedStatement がtrueの場合、文字列には値の代わりにプレースホルダーが含まれます。

rec の各フィールドで生成されるフラグは、そのフィールドが生成されるステートメントに含まれるかどうかを決定します。

このメソッドを使用すると、データベース固有の SQL 方言を気にすることなくテーブルを操作できます。プリペアされていないステートメントの場合、値は適切にエスケープされます。

WHERE ステートメントにおいて、rec の各 null 以外のフィールドは、フィールド値（または、プリペアードステートメントの場合はプレースホルダー）との等価性を条件とするフィルタ条件を指定します。ただし、プリペアードステートメントであるかどうかにかかわらず、null フィールドは条件「IS NULL」を指定し、プレースホルダーを導入することは決してありません。アプリケーションは、実行中に null フィールドに対してデータのバインドを試みてはなりません。 プレースホルダーを使用したい場合は、フィールドにNULL以外の値を設定する必要があります。さらに、NULL以外のフィールドは等価条件を指定し、SQLのNULLはそれ自体を含め何にも等しくないため、一般的にNULLをプレースホルダーにバインドすることは有用ではありません。

[virtual] QString QSqlDriver::stripDelimiters(const QString &identifier, QSqlDriver::IdentifierType type) const

先頭と末尾の区切り文字が削除されたidentifier を返します。identifier は、type の設定に応じて、テーブル名またはフィールド名のいずれかになります。identifier に先頭および末尾の区切り文字が含まれていない場合、identifier は変更されずに返されます。

QSqlDriver のサブクラスで独自の実装を提供したい場合は、この関数を再実装してください。

isIdentifierEscaped()も参照してください 。

[virtual] bool QSqlDriver::subscribeToNotification(const QString &name)

この関数は、データベースからのイベント通知を購読するために呼び出されます。name は、イベント通知を識別するものです。

成功した場合は true を返し、そうでない場合は false を返します。

この関数を呼び出す際には、データベースが開いている必要があります。close() を呼び出してデータベースを閉じると、登録済みのすべてのイベント通知の登録が自動的に解除されます。すでに開いているデータベースに対してopen() を呼び出すと、暗黙的にclose() が呼び出され、ドライバがすべてのイベント通知の登録を解除してしまう可能性があることに注意してください。

name で識別されるイベント通知がデータベースによって投稿されると、notification() シグナルが発信されます。

独自のQSqlDriver サブクラスでイベント通知のサポートを提供したい場合は、この関数を再実装してください。

unsubscribeFromNotification()、subscribedToNotifications()、およびQSqlDriver::hasFeature()も参照してください 。

[virtual] QStringList QSqlDriver::subscribedToNotifications() const

現在購読中のイベント通知の名前の一覧を返します。

独自のQSqlDriver サブクラスでイベント通知のサポートを提供したい場合は、この関数を再実装してください。

subscribeToNotification() およびunsubscribeFromNotification()も参照してください 。

[virtual] QStringList QSqlDriver::tables(QSql::TableType tableType) const

データベース内のテーブル名のリストを返します。デフォルトの実装では、空のリストが返されます。

tableType 引数は、どのタイプのテーブルを返すかを指定します。バイナリ互換性を確保するため、この文字列には列挙型QSql::TableTypesの値がテキストとして含まれます。下位互換性を確保するため、空の文字列はQSql::Tables として扱われる必要があります。

[virtual] bool QSqlDriver::unsubscribeFromNotification(const QString &name)

この関数は、データベースからのイベント通知の登録を解除するために呼び出されます。name は、イベント通知を識別するものです。

成功した場合は true を返し、そうでない場合は false を返します。

この関数を呼び出す際には、データベースが開いている必要があります。close() 関数が呼び出されると、登録済みのすべてのイベント通知の登録が自動的に解除されます。

この関数を呼び出した後、name で識別されるイベント通知がデータベースから投稿されても、notification() シグナルは発信されなくなります。

独自のQSqlDriver サブクラスでイベント通知のサポートを提供したい場合は、この関数を再実装してください。

subscribeToNotification() およびsubscribedToNotifications()も参照してください 。