SODA for In-Database JavaScriptによるドキュメント・コレクションの作成

SODA for In-Database JavaScriptを使用して新しいドキュメント・コレクションを作成する方法について説明します。

コレクションを使用すると、ドキュメントを論理的にグループ化できます。コレクションを作成またはコレクションにアクセスする前に、グローバルsodaオブジェクトを使用しないかぎり、いくつかのステップを完了する必要があります。まず接続オブジェクトを作成します。接続オブジェクトは、MLE JavaScriptモジュールでのすべてのSODA対話の開始点です:

// get a connection handle to the database session
const connection = oracledb.defaultConnection();

接続を取得したら、それを使用してConnection.getSodaDatabase()をコールでき、これは、コレクションを作成するための前提条件となります:

// get a SODA database
const db = connection.getSodaDatabase();

SODAデータベースが使用できる状態で最後に行うステップは、コレクションの作成です。コレクション名では大/小文字が区別されます:

// Create a collection with the name "MyCollection".
// This creates a database table, also named "MyCollection",
// to store the collection. If a collection with the same name
// exists, it will be opened
const col = db.createCollection("MyCollection");

前述の文は、デフォルトでJSONドキュメントを格納できるコレクションを作成します。SodaDatabase.createCollection()に渡されているコレクション名が既存のコレクション名である場合、単にそのコレクションがオープンします。また、SodaDatabase.openCollection()を使用して既存する既知のコレクションをオープンすることもできます。

カスタム・メタデータがSodaDatabase.createCollection() (非推奨)に指定されていないかぎり、デフォルトのコレクション・メタデータが提供されます。デフォルトのメタデータには、次の特性があります:

コレクション内の各ドキュメントには、次のコンポーネントがあります:
- キー
- コンテンツ
- バージョン
コレクションはJSONドキュメントのみを格納できます。
ドキュメントのキーとバージョン情報は自動的に生成されます。

オプションのコレクション・メタデータをcreateCollection()のコールに提供できますが、ほとんどの場合、デフォルトのコレクション構成をお薦めします。

すでに同じ名前のコレクションが存在する場合は、単にそのコレクションがオープンし、そのオブジェクトが戻されます。カスタム・メタデータがメソッドに渡され、そのメタデータが既存のコレクションのものと一致しない場合、コレクションはオープンせず、エラーが発生します。一致するには、すべてのメタデータ・フィールドが同じ値である必要があります。