Atlas Online Archive

stores

1
"stores" : [
2
  {
3
    "name" : "<string>",
4
    "provider": "<string>",
5
    "region": "<string>"
6
  }
7
]

stores

各オブジェクトがフェデレーティッドデータベースインスタンスに関連付けるデータ ストアを表すオブジェクトの配列。 フェデレーティッドデータベースインスタンス ストアは、 S 3バケット内のファイル、Atlas クラスター内のドキュメント、一般にアクセス可能なURLに保存されているファイル、または Atlas オンライン アーカイブを参照します。 Atlas Data Federation は、 storesオブジェクトで定義されたデータ ストアにのみアクセスできます。

stores.[n].name

フェデレーティッドデータベースインスタンス ストアの名前。 databases.[n].collections.[n].dataSources.[n].storeNameフィールドは、マッピング構成の一部としてこの値を参照します。

stores.[n].provider

スナップショット データが保存されるクラウドプロバイダー。 スナップショットの場合、値はdls:<subtype>である必要があります。 Atlas Data Federation は次のサブタイプをサポートしています。

• aws、値は次です: dls:aws

stores.[n].region

オンライン アーカイブのリージョン名。 各ストアは、アーカイブされたデータが保存される 1 つのリージョンに関連付けられています。 異なるリージョンに複数のオンライン アーカイブがある場合は、各リージョンのストアを追加して、そのリージョンのデータをフェデレーティッドデータベースインスタンス内の仮想データベースとコレクションにマッピングする必要があります。

Amazon Web Servicesでサポートされているリージョンの詳細については、「 Atlas Data Federationのリージョン 」を参照してください。

databases

1
"databases" : [
2
  {
3
    "name" : "<string>",
4
    "collections" : [
5
      {
6
        "name" : "<string>",
7
        "dataSources" : [
8
          {
9
            "storeName" : "<string>",
10
            "datasetName" : "<string>",
11
            "datasetPrefix": "<string>",
12
            "trimLevel": <int>,
13
            "provenanceFieldName": "<string>",
14
            "maxDatasets": <int>
15
          }
16
        ]
17
      }
18
    ],
19
    "views" : [ 
20
      {
21
        "name" : "<string>", 
22
        "source" : "<string>", 
23
        "pipeline" : "<string>" 
24
      }
25
    ] 
26
  }
27
]

databases

storesで定義された各フェデレーティッドデータベースインスタンス ストアとオンライン アーカイブとの間のマッピングを定義するオブジェクトの配列。 各オブジェクトは、データベース、そのコレクション、および任意でコレクション上のビューを表します。 各データベースには複数の オブジェクトとcollections viewsオブジェクトを保持できます。

databases.[n].name

Atlas Data Federation がデータ ストアに含まれるデータをマッピングするデータベースの名前。

databases.[n].collections

各オブジェクトがstoresフェデレーティッドデータベースインスタンス ストアにマッピングするコレクションとデータソースを表すオブジェクトの配列。

databases.[n].collections.[n].name

Atlas Data Federation が各 databases.[n].collections.[n].dataSources.[n].storeName に含まれるデータをマッピングするコレクションの名前。配列内の各オブジェクトは、コレクションと stores 配列内のオブジェクトとの間のマッピングを表します。

コレクション名に*を指定することで、コレクション名を動的に生成できます。 コレクション名を動的に生成するには、以下も指定する必要があります。

• databases.[n].collections.[n].dataSources.[n].datasetPrefix

• databases.[n].collections.[n].dataSources.[n].trimLevel

ワイルドカード コレクションの場合、Atlas Data Federation は最初に名前空間を$区切りのフィールドのリストに分割し、次にリストの左側からいくつかのフィールドを削除し、最後に以下を組み合わせて、データセット名をコレクション名にマッピングします。残りのフィールドに_を使用します。

databases.[n].collections.[n].dataSources

コレクションにマッピングするために、 stores配列にあるフェデレーティッドデータベースインスタンスを表すオブジェクトの配列。 コレクションのすべてのdataSourcesがオンライン アーカイブstoresにマップされている場合にのみ、ワイルドカード コレクションに複数のdataSourcesを指定できます。

databases.[n].collections.[n].dataSources.[n].storeName

<collection> にマッピングするフェデレーティッドデータベースインスタンス ストアの名前。stores 配列内のオブジェクトの name と一致する必要があります。

databases.[n].collections.[n].dataSources.[n].datasetName

コレクションにマッピングするオンライン アーカイブ データセットの名前。 datasetNameの形式は次のとおりです。

<version>$<type>$<subtype>$<clusterName>$<dbName>$<collectionName>$<archiveId>

例

次のオンライン アーカイブの名前を考えてみましょう。

v1$atlas$archive$clusterName$dbName$collections$archiveId

以下の説明では、

• v1 は、 のバージョンです

• atlas は、データソースの型です

• archive は、サブタイプであり、

• clusterName は、Atlas クラスターの名前です

• dbName は、Atlas クラスター上のデータベースの名前です

• collection は、 データベース内のコレクション

• archiveId は、アーカイブされたデータの一意の識別子です

注意

非ワイルドカード コレクションの場合、 databases.[n].collections.[n].dataSources.[n].datasetPrefixオプションを指定する場合はこのオプションを指定できません。Atlas Data Federation はdatabases.[n].collections.[n].dataSources.[n].datasetPrefixオプションで指定された名前を使用して、最新のデータセットのコレクションを自動的に生成するためです。

databases.[n].collections.[n].dataSources.[n].datasetPrefix

ワイルドカード コレクションに必須です。

オンライン アーカイブ データセット名と照合するためのデータセット名のプレフィックス。 ワイルドカード コレクションにこれを設定すると、Atlas Data Federation はコレクションを にマッピングし、プレフィックスがここで指定された値と一致するオンライン アーカイブ データセット名のみにマッピングします。

非ワイルドカード コレクションに対してこの設定を指定すると、Atlas Data Federation は最新のデータセット（最後にキャプチャされたスナップショット）のみをコレクションにマッピングします。 非ワイルドカード コレクションに対してこのオプションを指定する場合、 databases.[n].collections.[n].dataSources.[n].datasetNameも指定できません。

例

{
  ...,
  "name": "myFederatedDbCollection",
  "dataSources": [
    {
      "storeName": "aws-dl-store",
      "datasetPrefix": "v1$atlas$archive$MyCluster$MyDB$MyArchiveId"
    }
  ]
}

databases.[n].collections.[n].dataSources.[n].trimLevel

残りのフィールドをワイルドカード コレクション名にマッピングする前に、データセット名の左側から削除するデータセット名のフィールドの数を指定する符号なし整数。 値は0 より大きく、7 より小さくなければなりません。この設定は ワイルドカード コレクションでのみ設定できます。

Atlas UI のビジュアル エディターを使用してこの設定を構成することはできません。 したがって、この設定はデフォルトでビジュアル エディターを使用する構成の削除レベル5になります。

databases.[n].collections.[n].dataSources.[n].provenanceFieldName

結果にドキュメントの出所が含まれるフィールドの名前。ストレージ構成でこの設定を指定すると、Atlas Data Federation は結果の各ドキュメントに対して次のフィールドを返します。

フィールド名	説明
provider	フェデレーティッドデータベースインスタンスストレージ構成のプロバイダー（stores.[n].provider ）
clusterName	Atlas クラスターの名前
databaseName	Atlas クラスター上のデータベースの名前
collectionName	コレクションの名前
snapshotID	スナップショットを識別する一意の 24 桁の 16 進数文字string
dataSetName	オンライン アーカイブ データセットの名前（databases.[n].collections.[n].dataSources.[n].datasetName ）

Atlas UI のビジュアル エディターを使用してこの設定を構成することはできません。

databases.[n].collections.[n].dataSources.[n].maxDatasets

データソースのコレクションを動的に生成するデータセットの最大数を指定する、符号なし整数。 0より大きい値を指定する必要があります。 この設定は ワイルドカード コレクションでのみ設定できます。 Atlas Data Federation は、辞書編集順の逆順でデータセットを返します。

注意

Atlas UI のビジュアル エディターを使用してこの設定を構成することはできません。 したがって、Atlas Data Federation の構成には、ビジュアル エディターを使用した構成のデータセット数に制限はありません。