Skip to content

Commit 79c2d4c

Browse files
erabil-mdberabil-mdb
committed
Adds sample data.
1 parent 38d0448 commit 79c2d4c

File tree

4 files changed

+79
-46
lines changed

4 files changed

+79
-46
lines changed

‎source/includes/data-federation-instance-config-file.json‎

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
{
22
"cloudProviderConfig": {
33
"aws": {
4-
"externalId": "string",
4+
"externalId": "2fe853d3-4b5b-4le0-9414-s3b6ab040ccb",
55
"iamAssumedRoleARN": "arn:aws:iam::123456789012:root",
6-
"iamUserARN": "string",
7-
"roleId": "string"
6+
"roleId": "MY_ROLE"
87
}
98
},
109
"dataProcessRegion": {
1110
"cloudProvider": "AWS",
1211
"region": "SYDNEY_AUS"
1312
},
14-
"groupId": "32b6e34b3d91647abb20e7b8",
13+
"groupId": "32y6e74b3g91947azb20e3b8",
1514
"hostnames": [
16-
"string"
15+
"federateddatabaseinstance5-0ywks.a.query.myhost.com:37017"
1716
],
18-
"name": "string",
19-
"state": "UNVERIFIED",
17+
"name": "FederatedDatabaseInstance0",
18+
"state": "ACTIVE",
2019
"storage": {
2120
"databases": [
2221
{
@@ -25,44 +24,44 @@
2524
"dataSources": [
2625
{
2726
"allowInsecure": false,
28-
"collection": "string",
29-
"collectionRegex": "string",
30-
"database": "string",
31-
"databaseRegex": "string",
27+
"collection": "my-collection",
28+
"collectionRegex": "^list",
29+
"database": "my-database",
30+
"databaseRegex": ".*",
3231
"defaultFormat": ".avro",
33-
"path": "string",
34-
"provenanceFieldName": "string",
35-
"storeName": "string",
32+
"path": "/foo/path",
33+
"provenanceFieldName": "my-prov",
34+
"storeName": "my-store",
3635
"urls": [
37-
"string"
36+
"https://atlas-data-lake.s3.amazonaws.com/json/sample_airbnb/listingsAndReviews.json","https://atlas-data-lake.s3.amazonaws.com/json/sample_weatherdata/data.json"
3837
]
3938
}
4039
],
41-
"name": "string"
40+
"name": "my-collection-mdb"
4241
}
4342
],
4443
"maxWildcardCollections": 100,
45-
"name": "string",
44+
"name": "my-database-mdb",
4645
"views": [
4746
{
48-
"name": "string",
49-
"pipeline": "string",
50-
"source": "string"
47+
"name": "my-view",
48+
"pipeline": "[{"$group": {"_id": "$status","count": {"$sum": 1 }},"text": { "$push": "$text" }}},{ "$sort": {"count": 1 }}]",
49+
"source": "my-source-collection"
5150
}
5251
]
5352
}
5453
],
5554
"stores": [
5655
{
57-
"name": "string",
58-
"provider": "string",
56+
"name": "egAtlasStore",
57+
"provider": "atlas",
5958
"additionalStorageClasses": [
6059
"STANDARD"
6160
],
62-
"bucket": "string",
63-
"delimiter": "string",
61+
"bucket": "sample-data-atlas",
62+
"delimiter": "/",
6463
"includeTags": false,
65-
"prefix": "string",
64+
"prefix": "/sample",
6665
"public": false,
6766
"region": "US_GOV_WEST_1"
6867
}

‎source/reference/json.txt‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ you can pass a configuration file when using the {+atlas-cli+} to:
1919
- :ref:`Update a cloud backup schedule <atlas-backups-schedule-update>`.
2020
- :ref:`Create <atlas-clusters-search-indexes-create>` or
2121
:ref:`update an Atlas Search Index <atlas-clusters-search-indexes-update>`.
22+
- :ref:`Create a {+df+} database <atlas-dataFederation-create>`.
2223

2324
Usage
2425
-----
@@ -53,6 +54,9 @@ command. The commands you can use include but are not limited to:
5354
* - :ref:`atlas-clusters-search-indexes-update`
5455
- :oas-atlas-op:`Update One Atlas Search Index </updateAtlasSearchIndex>`
5556

57+
* - :ref:`atlas-dataFederation-create`
58+
- :oas-atlas-op:`Create One Federated Database Instance in One Project </createFederatedDatabase>`
59+
5660
When you run the command in your terminal, specify the ``--file`` option
5761
and provide the path to the |json| configuration file that defines your
5862
desired settings.
@@ -109,9 +113,17 @@ To learn more about |fts| index configuration files, see
109113
:ref:`atlas-cli-search-index-config-file`. For a sample file,
110114
see :ref:`example-search-index-config-file`.
111115

116+
{+adf+} Configuration File
117+
----------------------------------------
118+
119+
To learn more about {+adf+} configuration files, see
120+
:ref:`atlas-cli-data-federation-config-file`. For a sample file,
121+
see :ref:`example-fdi-config-file`.
122+
112123
.. toctree::
113124
:titlesonly:
114125

115126
/reference/json/cluster-config-file
116127
/reference/json/cloud-backup-schedule-config-file
128+
/reference/json/data-federation-config-file
117129
/reference/json/search-index-config-file

‎source/reference/json/data-federation-config-file.txt‎

Lines changed: 42 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,19 @@ settings for :ref:`creating a federated database
1717

1818
Use the following resources to:
1919

20-
- Learn the :ref:`required settings <required-dfi-settings>` you
20+
- Learn the :ref:`required settings <required-fdi-settings>` you
2121
can specify in the {+cluster+} configuration file.
2222
- View and copy :ref:`sample configuration files
23-
<example-dfi-config-file>`.
23+
<example-fdi-config-file>`.
2424

25-
.. _required-dfi-settings:
25+
.. _required-fdi-settings:
2626

2727
Required {+adf+} Settings
2828
---------------------------------------
2929

30-
|service| requires the following settings to create a {+dfi+} with
31-
the {+atlas-cli+}. You must specify these {+dfi+} settings either in the configuration file or as flags in the command:
30+
|service| requires the following settings to create a {+fdi+} with
31+
the {+atlas-cli+}. You must specify these {+fdi+} settings either in the configuration
32+
file or as flags in the command:
3233

3334
.. list-table::
3435
:header-rows: 1
@@ -38,44 +39,65 @@ the {+atlas-cli+}. You must specify these {+dfi+} settings either in the configu
3839
- Type
3940
- Description
4041

41-
* - ``cloudProviderConfig.aws``
42+
* - ``cloudProviderConfig.``
43+
``aws``
4244
- object
43-
- Cloud provider linked to this {+dfi+}.
45+
- Cloud provider linked to this {+fdi+}.
4446

45-
* - ``cloudProviderConfig.roleId``
47+
* - ``cloudProviderConfig.``
48+
``aws.``
49+
``roleId``
4650
- string
47-
- Unique identifier of the role that the {+dfi+} can use to access the data stores.
51+
- Unique identifier of the role that the {+fdi+} can use to access the data stores.
4852
Required if specifying ``cloudProviderConfig``.
4953

50-
* - ``cloudProviderConfig.testS3Bucket``
54+
* - ``cloudProviderConfig.``
55+
``aws.``
56+
``testS3Bucket``
5157
- string
5258
- Name of the |s3| data bucket that the provided role ID is authorized to access. Required if specifying ``cloudProviderConfig``.
5359

54-
* - ``dataProcessRegion.cloudProvider``
60+
* - ``dataProcessRegion.``
61+
``cloudProvider``
5562
- string
56-
- Name of the cloud service that hosts the {+dfi+}\'s data stores. For example, ``AWS``, ``GCP``, ``AZURE``, ``TENANT``, ``SERVERLESS``.
63+
- Name of the cloud service that hosts the {+fdi+}\'s data stores. For example, ``AWS``, ``GCP``, ``AZURE``, ``TENANT``, or ``SERVERLESS``.
5764

58-
* - ``dataProcessRegion.region``
65+
* - ``dataProcessRegion.``
66+
``region``
5967
- string
60-
- Name of the region to which the {+dfi+} routes client connections. For the full
68+
- Name of the region to which the {+fdi+} routes client connections. For the full
6169
list of available regions, see :ref:`Cloud Providers and Regions <create-cluster-cloud-provider-region>`.
6270

6371
* - ``name``
6472
- string
65-
- Human-readable label that identifies the {+dfi+}.
73+
- Human-readable label that identifies the {+fdi+}.
6674

67-
* - ``storage.stores.name``
75+
* - ``storage.``
76+
``stores.``
77+
``name``
6878
- string
6979
- Human-readable label that identifies the data store.
7080
The ``databases.[n].collections.[n].dataSources.[n].storeName`` field references
7181
this value as part of the mapping configuration. To use |service| as a data store,
72-
the {+dfi+} requires a serverless instance or an ``M10`` or higher {+cluster+}.
82+
the {+fdi+} requires a serverless instance or an ``M10`` or higher {+cluster+}.
7383

74-
* - ``storage.stores.provider``
84+
* - ``storage.``
85+
``stores.``
86+
``provider``
7587
- string
76-
- The :ref:`type of data store <config-adf>`. For example, ``atlas``, ``
88+
- The :ref:`type of data store <config-adf>`. For example, ``atlas``, ``http``, ``online_archive``, ``s3``, or ``DataLakeAzureBlobStore``.
7789

7890

7991
For a full list of available settings, see
8092
the request body schema in the API specification:
81-
:oas-atlas-op:`Create One Federated Database Instance in One Project </createFederatedDatabase>`.
93+
:oas-atlas-op:`Create One Federated Database Instance in One Project </createFederatedDatabase>`.
94+
95+
.. _example-fdi-config-file:
96+
97+
Example {+adf+} Configuration File
98+
------------------------------------------------
99+
100+
To create a {+fdi+}, specify the
101+
fields you want to update as shown in the following example file:
102+
103+
.. literalinclude:: /includes/data-federation-instance-config-file.json

‎submodules/mongodb-atlas-cli‎

Submodule mongodb-atlas-cli updated 467 files

0 commit comments

Comments
 (0)