B Oracle REST Data Servicesの構成ファイルについて
B.3 構成フォルダの構造を理解する
./ | +-defaults.xml +-apex.properties* +-url-mapping.xml | +conf/ | +-apex.xml +-apex_al.xml +-apex_rt.xml +-apex_pu.xml | ... +-(db-name).xml +-(db-name)_al.xml +-(db-name)_rt.xml +-(db-name)_pu.xml
defaults.xml
には、すべてのデータベース接続に適用されるグローバル設定が格納されています。
conf/
<db-name>
.xml
には、特定のデータベース接続(たとえば、デフォルトのapex
接続)に固有の設定が格納されています。<db-name>
は、データベース接続の名前です。
データベース接続がOracle Application ExpressのRESTfulサービスを使用する場合、_al.xml
、_rt.xml
および_pu.xml
などの名前のファイルが、APEX_LISTENER
、APEX_REST_PUBLIC_USER
およびORDS_PUBLIC_USER
のデータベース・ユーザー用の構成をそれぞれ格納します。
データベース接続がOracle REST Data ServicesのRESTfulサービスを使用する場合、<db-name>
_pu.xml
ファイルがORDS_PUBLIC_USER
データベース・ユーザーの構成を格納します。
B.4 構成ファイルの形式を理解する
構成ファイルは、各構成設定がキーおよびそれに対応する値からなる標準のJava XMLプロパティ・ファイル形式を使用します。defaults.xml
ファイルの例を次に示します。
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd"> <properties> <entry key="db.connectionType">basic</entry> <entry key="db.hostname">localhost</entry> <entry key="db.port">1521</entry> <entry key="db.sid">orcl</entry> <entry key="jdbc.DriverType">thin</entry> <entry key="jdbc.InitialLimit">3</entry> <entry key="jdbc.MinLimit">1</entry> <entry key="jdbc.MaxLimit">10</entry> <entry key="jdbc.MaxStatementsLimit">10</entry> <entry key="jdbc.InactivityTimeout">1800</entry> <entry key="jdbc.statementTimeout">900</entry> <entry key="jdbc.MaxConnectionReuseCount">1000</entry> </properties>
B.5 構成可能なパラメータの理解
表B-1に、defaults.xml
および(db-name).xml
構成ファイルの編集可能なパラメータを示します。
ノート:
構成ファイルの編集には、Oracle REST Data Servicesのコマンドライン・インタフェースおよびOracle SQL DeveloperのOracle REST Data Services Administrationを使用することをお薦めします。
表B-1 Oracle REST Data Servicesの構成ファイルのパラメータ
キー | 型 | 説明 | 例 | 設定タイプ |
---|---|---|---|---|
|
文字列 |
このパラメータは非推奨です。かわりに |
|
プール固有 |
cache.metadata.timeout |
文字列 |
メタデータ・レコードがキャッシュに残る期間を決定するための設定を指定します。期間が長いほど、適用された変更の表示に時間がかかります。 受け入れられる形式は、ISO-8601期間形式に基づきます。 |
1m | プール固有 |
cache.metadata.enabled |
文字列 |
メタデータ・キャッシュを有効または無効にする設定を指定します。 サポートされている値:
|
false |
プール固有 |
database.api.enabled |
文字列 |
データベースAPIが有効かどうかを指定します。
サポートされている値:
|
||
|
文字列 |
接続のタイプ。サポートされている値:
|
|
プール固有 |
|
文字列 |
データベースに接続するためのJDBC URL接続を指定します。 |
|
プール固有 |
|
文字列 |
Oracleデータベースのホスト・システムを指定します。 |
|
プール固有 |
|
文字列 |
指定されたデータベース・ユーザーのパスワードを指定します。暗号化して保存できるように、パスワードの先頭に感嘆符を含めます。 |
! |
プール固有 |
|
数値 |
データベース・リスナーのポートを指定します。 |
|
プール固有 |
|
文字列 |
データベースのネットワーク・サービス名を指定します。 |
|
プール固有 |
|
文字列 |
プールがCDBを指すこと、およびそのCDBに接続しているPDBをOracle REST Data Servicesによってアドレス可能にする必要があることを指定します(「Oracle REST Data Servicesによって、すべてのPDBをアドレス可能にする(プラガブル・マッピング)」を参照)。 |
|
プール固有 |
|
文字列 |
データベースの名前を指定します。 |
|
プール固有 |
|
文字列 |
|
|
プール固有 |
|
文字列 |
|
|
プール固有 |
|
文字列 |
接続のデータベース・ユーザーの名前を指定します。 |
|
プール固有 |
|
ブール値 |
ブラウザ上でエラーメッセージを表示するかどうかを指定します。 サポートされている値:
|
|
グローバル |
|
ブール値 |
エラー・メッセージを保持するかどうかを指定します。 サポートされている値:
|
|
グローバル |
error.responseFormat |
文字列 | HTTPエラー・レスポンスの書式設定方法を指定します。
サポートされている値:
|
json |
グローバル |
|
数値 |
保持するエラー・メッセージの合計数を指定します。 デフォルトは50です。 |
|
グローバル |
|
文字列 |
カスタム・エラー・ページが格納されているフォルダのパスを指定します。 |
|
グローバル |
|
数値 |
ウイルス・スキャン・ファイルへのInternet Content Adaptation Protocol (ICAP)ポートを指定します。
|
|
グローバル |
icap.secure.port |
数値 |
ウイルス・スキャン・ファイルへのInternet Content Adaptation Protocol (ICAP)ポートを指定します。
|
1344 |
グローバル |
|
文字列 |
ウイルス・スキャン・ファイルへのInternet Content Adaptation Protocol (ICAP)サーバーの名前またはIPアドレスを指定します。
|
|
グローバル |
|
文字列 |
JDBCドライバ・タイプの指定。サポートされている値:
|
|
プール固有 |
|
数値 |
閉じられる前に、使用可能な接続がアイドル状態を維持できる時間を指定します。非アクティブな接続のタイムアウトは秒単位です。 デフォルトは1800です。 |
|
プール固有 |
|
数値 |
作成される接続の数の初期サイズを指定します。 デフォルトは3です。(デフォルトは低いため、ほとんどの本番環境ではおそらくこれより高く設定すべきです。) |
|
プール固有 |
数値 |
破棄され、新規の接続と置き換わる前に、接続を再利用する最大回数を指定します。 デフォルトは1000です。 |
|
プール固有 | |
|
数値 |
接続の最大数を指定します。 デフォルトは10です。(一部の本番環境では低すぎる可能性があります。) |
|
プール固有 |
|
ブール値 |
PL/SQLゲートウェイ・コールをデータベース・ユーザーを使用して認証できるようにするかどうかを指定します。値が |
|
プール固有 |
|
数値 |
接続ごとにキャッシュする文の最大数を指定します。 デフォルトは10です。 |
|
プール固有 |
数値 |
接続の最小数を指定します。 デフォルトは1です。 |
|
プール固有 | |
|
数値 |
文のタイムアウト時間を指定します。 リクエストによって実行される異常に長い実行時間の問合せまたはスクリプトは、文にタイムアウトが設定されていないかぎり、ハング状態のままになることがあります。文にタイムアウトを設定すると、指定した期間内に問合せが完了しなかった場合に、すべての問合せが自動的にタイムアウトします。 デフォルトは900です。 |
|
プール固有 |
|
ブール値 |
ログ・メッセージを保持するかどうかを指定します。 サポートされている値:
|
|
グローバル |
|
数値 |
保持するログ・メッセージの合計数を指定します。 デフォルトは50です。 |
|
グローバル |
|
ブール値 |
プロシージャをログに記録するかどうかを指定します。 サポートされている値:
|
|
グローバル |
|
文字列 |
表示するデフォルトのページを指定します。一般的には、Oracle REST Data Servicesのホームページのapexが使用されます。 |
|
プール固有 |
|
数値 |
RESTfulサービスの処理で問合せから戻される、結果セットのネストしたカーソルから戻される行の最大数を指定します。リソースがページ分割されているかどうかにかかわらず、SQL問合せを使用して生成されるすべてのRESTfulサービスに影響します。 デフォルトは10000です。 |
|
プール固有 |
|
文字列 |
ファイルのアップロードで使用されるドキュメント表の名前を指定します。 デフォルト値は、 ノート: APEX 4.x以上では、このパラメータを使用しないでください。 |
|
プール固有 |
|
文字列 |
URLで指定されたプロシージャを実行した後に実行するプロシージャ名(複数可)を指定します。複数のプロシージャ名はカンマで区切ります。 |
|
プール固有 |
|
文字列 |
URLで指定されたプロシージャを実行する前に実行するプロシージャ名(複数可)を指定します。複数のプロシージャ名はカンマで区切ります。 |
|
プール固有 |
|
文字列 |
各Oracle REST Data ServicesベースのRESTサービスをディスパッチする前に起動するファンクションを指定します。このファンクションでは、データベース・セッションの構成の実行や、リクエストに対する追加の検証または認可を実行できます。ファンクションがtrue を返した場合、リクエストの処理は続行されます。ファンクションがfalse を返した場合、リクエストの処理は異常終了し、「HTTP403禁止」ステータスが返されます。
|
|
プール固有 |
|
ブール値 |
この値が ノート:Oracle REST Data Servicesの内部除外リストによって、ユーザーの次へのアクセスがブロックされます。
サポートされている値:
この値を |
|
グローバル |
|
文字列 |
ブラウザから直接実行することが禁じられているプロシージャ、パッケージまたはスキーマ名のパターンを指定します。 プロシージャ名には、ワイルドカード文字のアスタリスク( ノート: 複数のパターンはカンマで分割します。 |
|
グローバル |
|
文字列 |
ブラウザから直接実行することが許可されているプロシージャ、パッケージまたはスキーマ名のパターンを指定します。 プロシージャ名には、ワイルドカード文字のアスタリスク( ノート: 複数のパターンはカンマで分割します。 |
|
グローバル |
|
数値 |
キャッシュするプロシージャ検証の最大数を指定します。デフォルトは2000です。各リクエストで検証プロシージャを強制的に起動するには、この値を0に設定します。 |
|
グローバル |
|
文字列 |
URLでリクエストされたプロシージャの処理を許可するかどうかを判断する認証ファンクションを指定します。このファンクションは、プロシージャが許可されている場合は |
|
プール固有 |
文字列 |
URLでリクエストされたプロシージャの処理を許可するかどうかを判断するための検証関数を指定します。この関数は、プロジェクトを許可する場合はtrueを戻し、そうでない場合はfalseを戻す必要があります。 |
|
プール固有 | |
ブール値 |
その環境でHTTPSが利用可能かどうかを指定します。 サポートされている値:
この値をfalseに変更する場合は、「非HTTPS環境でOAuth2の使用」を参照してください。 |
|
グローバル | |
文字列 |
SODA REST APIを使用しているときに、制限がURLで指定されていない場合、コレクションのGETリクエストに返されるデフォルトのドキュメント数を指定します。正の整数または、制限をなくす「無制限」である必要があります。 デフォルトは100です。 |
|
プール固有 | |
文字列 |
SODA REST APIを使用しているときに、URLで指定された制限にかかわらず、コレクションURLでGETリクエストに返されるドキュメントの最大数を指定します。正の整数または、制限をなくす「無制限」である必要があります。 デフォルトは1000です。 |
|
プール固有 | |
|
ブール値 |
REST対応SQLサービスがアクティブかどうかを指定します。サポートされている値:
|
|
プール固有 |
関連項目:
詳細は、『Oracle SQL Developerユーザーズ・ガイド』の「Oracle REST Data Servicesのダウンロード、構成およびインストール」および「Oracle REST Data Servicesの管理」を参照してください。