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()も参照 。

[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 が文字データである場合、値は単一引用符で囲まれて返されます。埋め込まれたシングル・クオート文字はエスケープされます（2つのシングル・クオート文字に置き換えられます）。trimStrings がtrueの場合（デフォルトはfalse）、フィールドの末尾の空白はすべて取り除かれます。
• field が日付/時刻データの場合、値は ISO フォーマットでフォーマットされ、シングルクォーテーションで囲まれます。日付/時刻データが無効な場合、"NULL "が返される。
• field がbytearray データで、ドライバがバイナリ・フィールドを編集できる場合、値は 16 進文字列としてフォーマットされる。
• その他のフィールド・タイプでは、その値に対してtoString()が呼び出され、その結果が返される。

QVariant::toString()も参照のこと 。

[virtual] QVariant QSqlDriver::handle() const

QVariant でラップされた低レベルデータベースハンドルか、ハンドルがない場合は無効な variant を返します。

ここで返されるハンドルはデータベースに依存しているので、 アクセスする前にバリアントの型名を問い合わせる必要があります。

この例は 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())

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

この関数は、成功した場合は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 が真の場合、データベースのオープン状態はクローズに設定されることに注意してください (つまり、isOpen() はfalse を返します)。

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

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

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

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()も参照してください 。