RuntimePublic.Db API
RuntimePublic.Db APIは、外部データベースとの連携を可能にするための機能を提供します。
このAPIにより、環境管理コンソールで構成されたデータベースを拡張モジュールで呼び出すことができます。デフォルトでは、Integration Studioで作成したときに拡張機能のプロジェクトにインポートされます。このAPIを使用するには、拡張機能のプロジェクトでクラスを参照します。
これは、OutSystems.RuntimePublic.Db.NET名前空間にあります。
クラス
| 名前 | 説明 |
|---|---|
| Command | クエリを実行するコマンドを表します。 |
| CommittableTransaction | コミットやロールバック操作を使用して明示的に管理する必要があるトランザクションを表します。データを選択、挿入、更新、削除する際に使用できます。 |
| Connection | データベースへの接続を表します。 |
| DatabaseAccess | DatabaseProviderインスタンスを作成してデータベースにアクセスします。 |
| DatabaseProvider | 特定のデータベースへのアクセスを提供します。 |
| DataParameter | コマンドに関連付けられたクエリパラメータを表します。 |
| RequestTransaction | プラットフォームによって自動的に管理されるトランザクションを表します。トランザクションはWebリクエストの最初に開始され、クライアントにレスポンスが送信されるとコミットされます。データを選択、挿入、更新、削除する際に使用できます。 |
| SqlHelper | SQL文のメンバーの操作を支援する関数。 |
APIリファレンス
Command
クエリを実行するコマンドを表します。
メソッド
| 名前 | 説明 |
|---|---|
| DataParameter CreateParameter(string name, DbType type, object value) | 指定された型と値のパラメータをコマンドに追加します。パラメータ値は互換性のあるデータベース値に変更されます。 |
| DataParameter CreateParameter(string name) | コマンドにパラメータを追加します。パラメータ値は互換性のあるデータベース値に変更されます。 |
| void Dispose() | このオブジェクトによって使用されているリソースを開放します。 |
| int ExecuteNonQuery() | コマンドを実行し、影響を受ける行の数を返します。 |
| IDataReader ExecuteReader() | コマンドテキストを実行し、結果のSystem.Data.IDataReaderを返します。 |
| object ExecuteScalar() | クエリを実行し、クエリによって返される結果セットの最初の行の最初の列を返します。追加の列や行は無視されます。 |
| Connection GetConnection() | このコマンドに関連付けられたデータベース接続を返します。 |
| IDbCommand GetDriverCommand() | アプリケーションが実行されているスタックによって使用されるネイティブコマンドオブジェクトを返します。 |
| DataParameter GetParameter(string columnName) | 指定された名前のパラメータを取得します。 |
メンバー
| 名前 | 説明 |
|---|---|
| string CommandText | 実行するSQL文を取得または設定します。 |
| int CommandTimeout | コマンド実行のタイムアウトを取得または設定します。 |
CommittableTransaction
コミットやロールバック操作を使用して明示的に管理する必要があるトランザクションを表します。データを選択、挿入、更新、削除する際に使用できます。
メソッド
| 名前 | 説明 |
|---|---|
| void Close() | トランザクションを保留中状態からロールバックし、トランザクションを終了します。 |
| void Commit() | Commits the transaction. |
| Command CreateCommand(string sql) | このトランザクションで実行されるコマンドを作成します。 |
| Command CreateCommand() | このトランザクションで実行される空のコマンドを作成します。 |
| void Dispose() | トランザクションをリリースし、このオブジェクトによって使用されているリソースを開放します。 |
| Connection GetConnection() | このトランザクションに関連付けられたデータベース接続を取得します。 |
| IDbTransaction GetDriverTransaction() | アプリケーションが実行されているスタックによって使用されるネイティブトランザクションオブジェクトを返します。ネイティブトランザクションオブジェクトをパラメータとして受け取る既存のコードを再利用できます。 |
| void Rollback() | トランザクションを保留中状態からロールバックします。 |
Connection
データベースへの接続を表します。
メソッド
| 名前 | 説明 |
|---|---|
| CommittableTransaction BeginReadUncommittedTransaction() | トランザクションの分離レベルをread uncommittedに設定してOutSystems.RuntimePublic.Db.CommittableTransactionを作成します。 |
| CommittableTransaction BeginTransaction() | トランザクションの分離レベルをread uncommittedに設定してOutSystems.RuntimePublic.Db.CommittableTransactionを作成します。 |
| void Close() | データベースへの接続を終了します。 |
| Command CreateCommand(string sql) | 関連付けられたトランザクションがないコマンドを作成します。 |
| Command CreateCommand() | 関連付けられたトランザクションがない空のコマンドを作成します。 |
| void Dispose() | 接続を終了し、このオブジェクトによって使用されているリソースを開放します。 |
| IDbConnection GetDriverConnection() | アプリケーションが実行されているスタックによって使用されるネイティブ接続オブジェクトを返します。ネイティブ接続オブジェクトをパラメータとして受け取る既存のコードを再利用できます。 |
| bool IsClosed() | 接続が終了しているかどうかを確認します。 |
DatabaseAccess
DatabaseProviderインスタンスを作成してデータベースにアクセスします。
メソッド
| 名前 | 説明 |
|---|---|
| DatabaseProvider ForDatabase(string databaseName) | 指定されたデータベースカタログまたはスキームのデータベースプロバイダを返します。これを使用して、このデータベースを使用するように構成されたアプリケーションによって管理されるデータにアクセスします。 |
| DatabaseProvider ForExternalDatabase(string connectionName) | 特定の外部データベース接続のデータベースプロバイダを返します。これを使用して、外部システムによって管理されるデータにアクセスします。 |
| DatabaseProvider ForRunningApplication() | 現在実行中のアプリケーションのデータベースにアクセスするためのデータベースプロバイダを返します。これを使用して、現在実行中のアプリケーションや同じデータベースを共有する他のアプリケーションによって管理されるデータにアクセスします。 |
| DatabaseProvider ForSystemDatabase() | システムデータベースにアクセスするためのデータベースプロバイダを返します。これを使用して、プラットフォームメタモデルに対してクエリを実行します。 |
DatabaseProvider
特定のデータベースへのアクセスを提供します。
メソッド
| 名前 | 説明 |
|---|---|
| CommittableTransaction GetCommitableTransaction() | コミットやロールバックを使用して明示的に管理する必要がある新しいトランザクションを返します。 |
| RequestTransaction GetRequestTransaction() | Webリクエストの最初に開始され、クライアントにレスポンスが送信されるとコミットされるトランザクションを返します。このトランザクションを拡張機能内でコミットまたはロールバックすることはできません。 |
DataParameter
コマンドに関連付けられたクエリパラメータを表します。
メソッド
| 名前 | 説明 |
|---|---|
| IDbDataParameter GetDriverParameter() |
アプリケーションが実行されているスタックによって使用されるネイティブパラメータオブジェクトを返します。 |
メンバー
| 名前 | 説明 |
|---|---|
| DbType DbType | データベースの種類を取得または設定します。 |
| int Size | パラメータのサイズを設定します。 |
| object Value | パラメータ値を取得または設定します。 |
RequestTransaction
プラットフォームによって自動的に管理されるトランザクションを表します。トランザクションはWebリクエストの最初に開始され、クライアントにレスポンスが送信されるとコミットされます。データを選択、挿入、更新、削除する際に使用できます。
メソッド
| 名前 | 説明 |
|---|---|
| Command CreateCommand(string sql) | このトランザクションで実行されるコマンドを作成します。 |
| Command CreateCommand() | このトランザクションで実行される空のコマンドを作成します。 |
| void Dispose() | トランザクションをリリースし、このオブジェクトによって使用されているリソースを開放します。 |
| Connection GetConnection() | このトランザクションに関連付けられたデータベース接続を取得します。 |
| IDbTransaction GetDriverTransaction() | アプリケーションが実行されているスタックによって使用されるネイティブトランザクションオブジェクトを返します。ネイティブデータオブジェクトをパラメータとして受け取る既存のコードを再利用できます。 |
| void Release() | トランザクションが存在するかどうかを確認し、それに関連付けられたリソースを開放します。このトランザクションはプラットフォームによって自動的に管理されるため、トランザクションをリリースする際にコミット操作やロールバック操作は実行されません。 |
SqlHelper
SQL文のメンバーの操作を支援する関数。
メソッド
| 名前 | 説明 |
|---|---|
| string EscapeIdentifier(string identifier) | 識別子をクエリで使用できるようにエスケープします。 |
| string PrefixParam(string paramName) | クエリでプレースホルダとして使用したり、コマンドパラメータを作成するときにデファクトパラメータ名として使用したりするために、パラメータ名にプレフィックスを付けます。 |
このセクションの記事
- アプリケーションデータベースにデータを挿入する
- RuntimePublic APIを使用すると、アプリケーションデータベースにデータを挿入できます。
- 外部データベースのデータにクエリを実行する
- RuntimePublic APIを使用すると、外部データベースのデータにクエリを実行できます。