このページでは、CData Cloud でのMongoDB への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

MongoDB への接続

接続の確立 は、CData Cloud にデータベースを作成するためのMongoDB への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してMongoDB からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。

Database タブで対応するアイコンを選択して、MongoDB に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

MongoDB への接続

次の接続プロパティを設定し、単一のMongoDB インスタンスに接続します。

• Server：MongoDB インスタンスが実行されているサーバーの名前またはアドレスに設定。ポートはここで指定できます。またはPort で指定します。
• Database：読み書きするデータベースに設定。

DNS シードリストを使用してMongoDB に接続

• Server："mongodb+srv://"" + MongoDB インスタンスが実行されているサーバーの名前に設定。ポートはここで指定できます。またはPort で指定します。
• Database：読み書きするデータベースに設定。
• DNSServer：必要なDNS エントリを解決できるDNSServer のホスト名に設定。

レプリカセットへの接続

レプリカセットに接続するには、前述の接続プロパティに加えて、 次の設定を行います。

• ReplicaSet：アドレスとポートで指定されたレプリカセット内のセカンダリサーバーのカンマ区切りリストに設定。
• SlaveOK：セカンダリ（スレーブ）サーバーから読み出す場合は、これをtrue に設定。
• ReadPreference：これを設定すると、Cloud のセカンダリサーバーからの読み出し方法が微調整されます。

セキュアなMongoDB への接続

UseSSL を設定すると、接続時にSSL/TLS 暗号化をネゴシエートできます。

MongoDB 接続の認証

サポートされているAuthScheme 認証タイプ（MONGODB-CR、SCRAM-SHA-1、SCRAM-SHA-256、PLAIN、GSSAPI）は、チャレンジレスポンス認証とLDAP です。

チャレンジレスポンス

チャレンジレスポンス認証では、User とPassword プロパティは、MongoDB データベースに格納されているユーザー名とパスワードに対応しています。1つのデータベースのデータに接続し、別のデータベースを認証する必要がある場合は、Database とAuthDatabase の両方を設定します。

LDAP

LDAP 認証を使用するには、AuthDatabase を"$external" に設定し、AuthScheme をPLAIN に設定します。この値はSASL PLAIN メカニズムを指定します。このメカニズムは視覚情報をプレーンテキストで送信するため、信頼できないネットワークではTLS/SSL なしでは使用できません。

X.509 証明書

X.509 証明書認証を使用するには、AuthScheme をX509 に設定します。

Amazon DocumentDB クラスターへの接続

Amazon DocumentDB に接続する前に、まずAmazon DocumentDB クラスターと、mongo シェルを含むEC2 インスタンスが実行されていることを確認する必要があります。

次に、EC2 インスタンスへのSSH トンネルを以下のように設定します。

1. AWS 管理コンソールから、［サービス］->［データベース］->［Amazon DocumentDB］を選択します。DocumentDB 管理ページから、［クラスター］を選択して、クラスターをクリックします。
2. ［接続］セクションで、サンプル接続文字列にある--host の値とそのポートに注意してください。
3. ［サービス］->［Compute］->［EC2］に移動します。［実行中のインスタンス］を選択します。
4. インスタンスを選択して、［接続］ボタンをクリックします。
5. ［Example］セクションで、<ami_username>@<Public DNS> の形式で示される、インスタンスとユーザーを識別する値に注意してください。
6. お好みのSSH クライアントで、EC2インスタンスの［接続］ページのHost Name（username@publicDNS）とPort22 を使用して、EC2 インスタンスへの接続を確立します。
7. 認証用に、EC2インスタンスの秘密鍵ファイルを指定します（Putty ではキーを.pem から.ppk に変換する必要があります）。
8. DocumentDB クラスターページのポートとホスト名を使用して、SSH トンネルを構成します。
9. EC2仮想マシンに接続を確立します。

DocumentDB クラスターに接続するには、以下を指定します。

• Server：SSH トンネルをホストしているマシン名に設定。
• Port：SSH トンネルがホストされているポートに設定。
• User：DocumentDB クラスターのプロビジョニングに使用するマスターユーザー名に設定。
• Password：DocumentDB クラスターのプロビジョニング時に設定したマスターパスワードに設定。
• UseSSL：true に設定。
• UseFindAPI：true に設定。

MongoDB API を使用したCosmosDB への接続

MongoDB API を使ってCosmos DB アカウントに接続するために必要な接続文字列を取得するには、Azure Portal にログインして［Azure Cosmos DB］を選択し、自分のアカウントを選択します。［Settings］セクションで、［Connection String］をクリックして次の値を設定します。

• Server：Host 値（アカウント用にプロビジョニングされたサーバーのFQDN）に設定。ポートもここで指定できます。またはPort で指定します。
• Port：ポートに設定。
• Database：読み書きするデータベースに設定。
• User：データベースユーザーに設定。
• Password：ユーザーのパスワードに設定。

Atlas、ObjectRocket、または別のDBaaS プロバイダーに接続する場合は、通常、［接続の確立］に記載されている手順にいくつかのバリエーションがあります。次のセクションでは、いくつかの一般的なサービスに必要な接続プロパティを取得する方法について説明します。

Atlas

MongoDB Atlas には、MongoDB ユーザーまたはLDAP ユーザーで認証できます。次のセクションでは、Atlas 接続文字列をCloud 接続プロパティにマッピングする方法を説明します。Atlas 接続文字列を取得する方法は次のとおりです。

1. Clusters ビューで、接続するクラスタのConnect をクリックします。
2. Connect Your Application をクリックします。
3. いずれかのドライバーオプションを選択すると、接続文字列が表示されます。

前提条件

MongoDB ユーザーの作成および／またはLDAP の設定に加えて、Atlas プロジェクトのホワイトリストに、Cloud が接続しているマシンのIP アドレスが含まれている必要があります。ホワイトリストにIP アドレスを追加するには、［Clusters］ビューで［Security］タブを選択し、［IP Whitelist］->［Add IP Address］をクリックします。

MongoDB ユーザー資格情報

次は、MongoDB ユーザー資格情報を提供する接続文字列の例です。

mongodb://USERNAME:[email protected]:27017,cluster0-shard-00-01.mongodb.net:27017,cluster0-shard-00-02.mongodb.net:27017/test?ssl=true&replicaSet=Cluster0-shard-0&authSource=admin

• AuthScheme：MongoDB バージョン3.0、3.2、3.4、および3.6 に対応するSCRAM-SHA-1。
• Server：レプリカセットの最初のサーバー。あるいは、プライマリまたはセカンダリサーバーを指定できます（Cloud はServer とReplicaSet 内のサーバーをクエリしてプライマリを検索します）。
  

  cluster0-shard-00-00.mongodb.net

• Port：サーバーが稼働しているポート（デフォルトは27017）。
• ReplicaSet：レプリカセット内の他のサーバー。Server とReplicaSet は、MongoDB レプリカセット内のすべてのインスタンスを一緒に指定します。ReplicaSet にサーバー名およびポートを両方指定します。
  

  mycluster0-shard-00-01.mongodb.net:27017,mycluster0-shard-00-02.mongodb.net:27017

• SlaveOK：レプリカセット内のセカンダリ（スレーブ）サーバーからの読み取りを許可する場合は、true。
• AuthDatabase：MongoDB Atlas に接続する場合は、"admin"。Atlas のすべてのMongoDB ユーザーは、管理データベース、すなわち認証データベースに関連付けられています。
• Database：読み書きするデータベース。

• User：MongoDB プロジェクトに追加したMongoDB ユーザーのユーザー名。

• Password：MongoDB ユーザーのパスワード。

• UseSSL：true。Atlas はTLS / SSLを必要とします。

LDAP

次のリストは、LDAP ユーザーで認証するためのMongoDB Atlas の要件を示しています。 以下はMongo クライアントに接続するためのコマンド例です。

mongo "mongodb://cluster0-shard-00-00.mongodb.net:27017,cluster0-shard-00-01.mongodb.net:27017,cluster0-shard-00-02.mongodb.net:27017/test?ssl=true&replicaSet=Cluster0-shard-0&authSource=$external" --authenticationMechanism PLAIN --username cn=rob,cn=Users,dc=atlas-ldaps-01,dc=myteam,dc=com 

• Server：レプリカセットの最初のサーバー。または、別のプライマリまたはセカンダリサーバーを指定できます（Cloud はServer とReplicaSet 内のサーバーをクエリしてプライマリを検索します）。 次に例を示します。
  

  cluster0-shard-00-00.mongodb.net

• Port：サーバーが稼働しているポート（デフォルトは27017）。
• ReplicaSet：レプリカセット内の他のサーバー。Server とReplicaSet は、MongoDB レプリカセット内のすべてのインスタンスを一緒に指定します。 以下に値の例を示します。
  

  mycluster0-shard-00-01.mongodb.net:27017,mycluster0-shard-00-02.mongodb.net:27017

• SlaveOK：レプリカセット内のセカンダリ（スレーブ）サーバーからの読み取りを許可する場合は、true。

• AuthScheme：LDAP 認証のPLAIN。

• Database：読み書きするデータベース。

• AuthDatabase：LDAP ユーザーで認証する場合は、"$external"。

• User：Atlas ユーザー名としてLDAP サーバーにあるユーザーの完全な識別名（DN）。次に例を示します。
  

  cn=rob,cn=Users,dc=atlas-ldaps-01,dc=myteam,dc=com

• Password：LDAP ユーザーのパスワード。

• UseSSL：true。Atlas はTLS / SSLを必要とします。

ObjectRocket

ObjectRocket に接続するには、データベースユーザーの資格情報を使用して認証します。コントロールパネルから必要な接続プロパティを取得できます。［インスタンス］ページでインスタンスを選択し、［接続］メニューを選択してMongoDB 接続文字列を表示します。

前提条件

データベースにユーザーを追加することに加えて、Cloud が接続しているマシンのIP アドレスへのアクセスも許可する必要があります。これを設定するには、［インスタンス］ページでインスタンスを選択し、［Add ACL］をクリックします。

MongoDB ユーザー

mongodb://YOUR_USERNAME:[email protected]:52826,abc123-d4-2.mongo.objectrocket.com:52826,abc123-d4-1.mongo.objectrocket.com:52826/YOUR_DATABASE_NAME?replicaSet=89c04c5db2cf403097d8f2e8ca871a1c

• Server：レプリカセットの最初のサーバー。サーバー名を取得するには、［レプリカセット］をクリックします。または、別のプライマリまたはセカンダリサーバーを指定できます（Cloud はServer とReplicaSet 内のサーバーをクエリしてプライマリを検索します）。
  

  abc123-d4-0.mongo.objectrocket.com

• Port：サーバーが稼働しているポート（デフォルトは27017）。
• ReplicaSet：レプリカセット内の他のサーバー。Server とReplicaSet は、MongoDB レプリカセット内のすべてのインスタンスを一緒に指定します。 以下に値の例を示します。
  

  abc123-d4-2.mongo.objectrocket.com:52826,abc123-d4-1.mongo.objectrocket.com:52826

• Database：読み書きするデータベース。これは、接続しているユーザーの認証データベースでもあることに注意してください。データベースユーザーは、ObjectRocket のデータベース外の他のデータベースと対話することはできません。
• User：Database に定義したMongoDB ユーザーのユーザー名。
• Password：データベースユーザーのパスワード。
• UseSSL：TLS / SSL を有効にする場合は、true。

MongoDB はスキーマレスなドキュメントデータベースで、高いパフォーマンス、使用性、およびスケーラビリティを提供します。これらの機能は、必ずしもSQL-92 のような標準準拠のクエリ言語と互換しないわけではありません。このセクションでは、Cloud が複数のやり方によって、リレーショナルSQL とドキュメントデータベースのギャップの橋渡しをいかに行うかを説明します。

テーブルとしてのMongoDB オブジェクトの操作

Cloud では、スキーマレスなMongoDB オブジェクトをリレーショナルテーブルにモデル化し、SQL クエリをMongoDB クエリに読み替えることで、要求されたデータを取得します。 さまざまなMongoDB 操作がSQL としてどのように表されるかの詳細については、クエリマッピング を参照してください。

スキーマの自動検出

自動スキーマ検出 スキームでは、設定された行数のオブジェクトをスキャンすることで、自動的にMongoDB 内のデータ型を見つけます。MongoDB コレクションのリレーショナル表現をコントロールするためにRowScanDepth、FlattenArrays、およびFlattenObjects を使うことができます。スキーマに結びついていない自由形式クエリ を記述することもできます。

Cloud は、コレクション内のMongoDB ドキュメントをサンプルとして調べ、リレーショナルスキーマを提案します。RowScanDepth プロパティを使って、Cloud がスキャンするドキュメント数を設定することができます。検出プロセスで特定されるカラムはFlattenArrays およびFlattenObjects プロパティに依存します。

オブジェクトのフラット化

FlattenObjects が設定されている場合、すべてのネストされたオブジェクトは連続したカラムにフラット化されます。例えば、次のドキュメントを考えましょう。

{
  id: 12,
  name: "Lohia Manufacturers Inc.",
  address: {street: "Main Street", city: "Chapel Hill", state: "NC"},
  offices: ["Chapel Hill", "London", "New York"],
  annual_revenue: 35,600,000
}

FlattenObjects が設定されていない場合、address.street、address.city、およびaddress.state カラムは別々にはなりません。文字列型の住所カラムは一つのオブジェクトとして表されます。値は次のようになります {street:"Main Street", city:"Chapel Hill", state:"NC"}。JSON アグリゲートの詳細についてはJSON 関数 を参照してください。

配列のフラット化

FlattenArrays プロパティは配列の値をフラット化してそれぞれのカラムとするために使われます。これは次の例のように短い配列の場合にのみ推奨されます。

"coord": [ -73.856077, 40.848447 ]

アンバウンドの配列をそのままにしておき、必要な際にJSON 関数 を使ってデータを取り出すことをお勧めします。

自動スキーマ検出 の説明にあるとおり、直感的なテーブルスキーマは非構造化MongoDB データへのSQL アクセスを可能にします。JSON 関数 は標準のJSON 関数を使ってMongoDB データをサマライズし、あらゆるネスト構造から値を抽出できます。 カスタムスキーマ定義 では静的なテーブルを定義でき、データのリレーショナルビューでの緻密な制御を可能にします。例えば、parent/child テーブルやfact/dimension テーブルを定義するスキーマを記述することができます。 しかし、これらのスキーマに限定されません。

接続後は、どんなネストされた構造でもデータをフラット化せずにクエリできますFlattenArrays やFlattenObjects でアクセスできるあらゆるリレーションへは、アドホックなSQL クエリを使ってもアクセスが可能です。

次のRestaurant データセットからのサンプルドキュメントを考えてみましょう。

 
{
  "address": {
    "building": "1007",
    "coord": [
      -73.856077,
      40.848447
    ],
    "street": "Morris Park Ave",
    "zipcode": "10462"
  },
  "borough": "Bronx",
  "cuisine": "Bakery",
  "grades": [
    {
      "grade": "A",
      "score": 2,
      "date": {
        "$date": "1393804800000"
      }
    },
    {
      "date": {
        "$date": "1378857600000"
      },
      "grade": "B",
      "score": 6
    },
    {
      "score": 10,
      "date": {
        "$date": "1358985600000"
      },
      "grade": "C"
    }
  ],
  "name": "Morris Park Bake Shop",
  "restaurant_id": "30075445"
} 

SELECT [address.building], [grades.1.grade] FROM restaurants WHERE restaurant_id = '30075445'

ドキュメントの配列を、個別のテーブルのように取得することが可能です。例えば、restaurants コレクションから次のJSON 構造を取得します。

{
  "_id" : ObjectId("568c37b748ddf53c5ed98932"),
  "address" : {
    "building" : "1007",
    "coord" : [-73.856077, 40.848447],
    "street" : "Morris Park Ave",
    "zipcode" : "10462"
  },
  "borough" : "Bronx",
  "cuisine" : "Bakery",
  "grades" : [{
      "date" : ISODate("2014-03-03T00:00:00Z"),
      "grade" : "A",
      "score" : 2
    }, {
      "date" : ISODate("2013-09-11T00:00:00Z"),
      "grade" : "A",
      "score" : 6
    }, {
      "date" : ISODate("2013-01-24T00:00:00Z"),
      "grade" : "A",
      "score" : 10
    }, {
      "date" : ISODate("2011-11-23T00:00:00Z"),
      "grade" : "A",
      "score" : 9
    }, {
      "date" : ISODate("2011-03-10T00:00:00Z"),
      "grade" : "B",
      "score" : 14
    }],
  "name" : "Morris Park Bake Shop",
  "restaurant_id" : "30075445"
}

SELECT * FROM [restaurants.grades]

ベースのrestaurants テーブルからの情報も含めたい場合は、結合を使って実現できます。フラット化された配列はルートドキュメントでのみ結合できます。Cloud では、結合の左部分を、垂直にフラット化したい配列ドキュメントだと判断します。SupportEnhancedSQL を無効にして、ネストされたMongoDB ドキュメントを結合します。このタイプのクエリはMongoDB API 経由でサポートされています。

SELECT [restaurants].[restaurant_id], [restaurants.grades].* FROM [restaurants.grades] JOIN [restaurants] WHERE [restaurants].name = 'Morris Park Bake Shop'

他の配列の中にある配列を対象としたクエリを作成することも可能です。

以下がInventory コレクションの例です。

{
	"_id": {
		"$oid": "xxxxxxxxxxxxxxxxxxxxxx"
	},
	"Company Branch": "Main Branch",
	"ItemList": [
		{
			"item": "journal",
			"instock": [
				{
					"warehouse": "A",
					"qty": 15
				},
				{
					"warehouse": "B",
					"qty": 45
				}
			]
		},
		{
			"item": "paper",
			"instock": [
				{
					"warehouse": "A",
					"qty": 50
				},
				{
					"warehouse": "B",
					"qty": 5
				}
			]
		}
	]
}

Insert data into the nested arrays using the syntax of <parent array>.<index>.<child array>, as follows:

INSERT INTO [Inventory.ItemList] (p_id, item, [instock.0.warehouse], [instock.0.qty], [instock.0.price]) VALUES ('xxxxxxxxxxxxxxxxxxxxxx', 'NoteBook', 'B', 20, '5$')

The Inventory collection after executing the INSERT statement:

{
	"_id": {
		"$oid": "xxxxxxxxxxxxxxxxxxxxxx"
	},
	"Company Branch": "Main Branch",
	"ItemList": [
		{
			"item": "journal",
			"instock": [
				{
					"warehouse": "A",
					"qty": 15
				},
				{
					"warehouse": "B",
					"qty": 45
				}
			]
		},
		{
			"item": "paper",
			"instock": [
				{
					"warehouse": "A",
					"qty": 50
				},
				{
					"warehouse": "B",
					"qty": 5
				}
			]
		},
		{
			"item": "NoteBook",
			"instock": [
				{
					"warehouse": "B",
					"qty": 20,
					"price": "5$"
				}
			]
		}
	]
}

Cloud では、JSON ストラクチャーをカラム値として返すことができます。Cloud を使って、これらのJSON ストラクチャーにおいて標準SQL 関数を使用できます。このセクションの例では、次の配列を使用します。

[
     { "grade": "A", "score": 2 },
     { "grade": "A", "score": 6 },
     { "grade": "A", "score": 10 },
     { "grade": "A", "score": 9 },
     { "grade": "B", "score": 14 }
]

JSON_EXTRACT

SELECT Name, JSON_EXTRACT(grades,'[0].grade') AS Grade, JSON_EXTRACT(grades,'[0].score') AS Score FROM Students;

JSON_COUNT

SELECT Name, JSON_COUNT(grades,'[x]') AS NumberOfGrades FROM Students;

JSON_SUM

SELECT Name, JSON_SUM(score,'[x].score') AS TotalScore FROM Students;

JSON_MIN

SELECT Name, JSON_MIN(score,'[x].score') AS LowestScore FROM Students;

JSON_MAX

SELECT Name, JSON_MAX(score,'[x].score') AS HighestScore FROM Students;

DOCUMENT

DOCUMENT 関数はすべてのドキュメントをJSON 文字列として取得する場合に用いられます。例として、次のクエリとその結果をご覧ください。

SELECT DOCUMENT(*) FROM Customers;

{ "id": 12, "name": "Lohia Manufacturers Inc.", "address": { "street": "Main Street", "city": "Chapel Hill", "state": "NC"}, "offices": [ "Chapel Hill", "London", "New York" ], "annual_revenue": 35,600,000 }

Cloud は、SQL クエリを対応するMongoDB クエリにマッピングします。ここではトランスフォーメーションの詳細は説明しませんが、いくつか代表的なものを説明します。Cloud は、Aggregation Framework などのMongoDB の機能の良いところを使って望まれる結果を出します。

SELECT クエリ

SELECT * FROM Users

db.users.find()

SELECT user_id, status 
FROM Users

db.users.find(
  {}, 
  { user_id: 1, status: 1, _id: 0 }
)

SELECT * 
FROM Users 
WHERE status = 'A'

db.users.find( 
  { status: "A" }
)

SELECT * 
FROM Users 
WHERE status = 'A' OR age=50

db.users.find(
  { $or: [ { status: "A" }, 
           { age: 50 } ] }
)

SELECT * 
FROM Users 
WHERE name LIKE 'A%'

db.users.find(
  {name: /^a/}
)

SELECT * FROM Users 
WHERE status = 'A'
ORDER BY user_id ASC

db.users.find( { status: "A" }.sort( { user_id: 1 } )

SELECT * 
FROM Users 
WHERE status = 'A' 
ORDER BY user_id DESC

db.users.find( {status: "A" }.sort( {user_id: -1} )

Aggregate クエリ

SELECT Count(*) As Count 
FROM Orders

db.orders.aggregate( [ 
  { 
    $group: { 
      _id: null, 
      count: { $sum: 1 } 
    } 
  } 
] )

SELECT Sum(price) As Total 
FROM Orders

db.orders.aggregate( [ 
  { 
    $group: { 
      _id: null, 
      total: { $sum: "$price" } 
    }
  } 
] )

SELECT cust_id, Sum(price) As total 
FROM Orders 
GROUP BY cust_id 
ORDER BY total

db.orders.aggregate( [ 
  { 
    $group: { 
      _id: "$cust_id", 
      total: { $sum: "$price" } 
    } 
  } ,
  { $sort: {total: 1 } }
] )

SELECT cust_id, ord_date, Sum(price) As total 
FROM Orders 
GROUP BY cust_id, ord_date 
HAVING total > 250

db.orders.aggregate( [ 
  { 
    $group: { 
      _id: { 
        cust_id: "$cust_id", 
        ord_date: { 
          month: { $month: "$ord_date" }, 
          day: { $dayOfMonth: "$ord_date" }, 
          year: { $year: "$ord_date"} 
        } 
      }, 
      total: { $sum: "$price" } 
    }
  }, 
  { $match: { total: { $gt: 250 } } } 
] )

INSERT ステートメント

INSERT INTO users (user_id, age, status, [address.city], [address.postalcode]) 
VALUES ('bcd001', 45, 'A', 'Chapel Hill', 27517)

db.users.insert( 
  { user_id: "bcd001", age: 45, status: "A", address:{ city:"Chapel Hill", postalCode:27514} }
) 

INSERT INTO t1 ("c1") VALUES (('a1', 'a2', 'a3'))

db.users.insert({"c1": ['a1', 'a2', 'a3']})

INSERT INTO t1 ("c1") VALUES (())

db.users.insert({"c1": []})

INSERT INTO t1 ("a.b.c.c1") VALUES (('a1', 'a2', 'a3'))

db.users.insert("a":{"b":{"c":{"c1":['a1','a2', 'a3']}}})

更新ステートメント

UPDATE users 
SET status = 'C', [address.postalcode] = 90210
WHERE age > 25

db.users.update( 
  { age: { $gt: 25 } }, 
  { $set: { status: "C", address.postalCode: 90210 }, 
  { multi: true }
) 

削除ステートメント

DELETE FROM users WHERE status = 'D'

db.users.remove( { status: "D" } )

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、MongoDB のデータベースメタデータを返します。

• sys_catalogs：利用可能なデータベースをリスト。
• sys_schemas：利用可能なスキーマをリスト。
• sys_tables：利用可能なテーブルおよびビューをリスト。
• sys_tablecolumns：利用可能なテーブルおよびビューのカラムについて説明。
• sys_procedures：利用可能なストアドプロシージャについて説明。
• sys_procedureparameters：ストアドプロシージャパラメータについて説明。
• sys_keycolumns：主キーおよび外部キーについて説明。
• sys_indexes：利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

• sys_connection_props：利用可能な接続プロパティについての情報を返す。
• sys_sqlinfo：Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリ（バッチ処理を含む）のクエリ統計を返します。

• sys_identity：バッチ処理または単一の更新に関する情報を返す。

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas
          

Columns

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables
          

Columns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、[CData].[Sample].Customers テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Customers' AND CatalogName='CData' AND SchemaName='Sample'

Columns

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures
          

Columns

ストアドプロシージャパラメータについて説明します。

次のクエリは、AddDocument ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName='AddDocument' AND Direction=1 OR Direction=2

Columns

主キーおよび外部キーについて説明します。

次のクエリは、[CData].[Sample].Customers テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Customers' AND CatalogName='CData' AND SchemaName='Sample'
          

Columns

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys
          

Columns

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠 を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Columns

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity
          

Columns

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns

ストアドプロシージャはファンクションライクなインターフェースで、MongoDB の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMongoDB から関連するレスポンスデータを返します。

CData Cloud - MongoDB ストアドプロシージャ

全JSON ドキュメントをMongoDB にそのまま挿入します。

Input

Result Set Columns

Creates a schema file for the collection.

Input

Result Set Columns

パススルークエリでドキュメントを取得します。

Input

Result Set Columns

ドキュメント全体を文字列として取得します。

Input

Result Set Columns

SSL 設定のカスタマイズ

TLS を有効化するには、UseSSL をTrue に設定します。

この設定により、Cloud はサーバーとのTLS ネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

クライアントSSL 証明書

MongoDB Cloud はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。

• SSLClientCert：クライアント証明書のための証明書ストア名。
• SSLClientCertType：TLS / SSL クライアント証明書を格納するキーストアの種類。
• SSLClientCertPassword：TLS / SSL クライアント証明書のパスワード。
• SSLClientCertSubject：TLS / SSL クライアント証明書のサブジェクト。

Firewall またはProxy 経由の接続

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

Authentication

SSL

SSH

Logging

Schema

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

The authentication mechanism that MongoDB will use to authenticate the connection.

Possible Values

データ型

string

デフォルト値

"SCRAM-SHA-1"

解説

Accepted values are MONGODB-CR, SCRAM-SHA-1, SCRAM-SHA-256, GSSAPI, PLAIN, and NONE. The following authentication types correspond to the authentication values.

Authenticating with Challenge-Response

Generally, this property does not need to be set for this authentication type, as the Cloud uses different challenge-response mechanisms by default to authenticate a user to different versions of MongoDB.

• MongoDB 2: MongoDB 2 uses MONGODB-CR to authenticate.
• MongoDB 3.x: MongoDB 3 uses SCRAM-SHA-1 by default; new users you create in MongoDB 3 use this authentication method. However, MongoDB 3 servers will continue to use MONGODB-CR to authenticate users created in MongoDB 2.6.
• MongoDB 4.x: MongoDB 4 uses SCRAM-SHA-1 by default and does not support the deprecated MongoDB MONGODB-CR authentication mechanism.

Authenticating with LDAP

Set AuthScheme to PLAIN to use LDAP authentication. This value specifies the SASL PLAIN mechanism; note that this mechanism transmits credentials over plain-text, so it is not suitable for use without TLS/SSL on untrusted networks.

Authenticating with Kerberos

Set AuthScheme to GSSAPI to use Kerberos authentication. Additionally configure the following properties as configured for the MongoDB environment:

Authenticating with X.509 Authentication

Set AuthScheme to X509 to use X.509 certificate authentication.

MongoDB データベースをホストしているサーバーのホスト名、またはIP アドレス。

データ型

string

デフォルト値

"localhost"

解説

MongoDB データベースをホストしているサーバーのホスト名、またはIP アドレス。DNS シードリストを使用して接続する場合は、このオプションを"mongodb+srv://" + MongoDB インスタンスが実行されているサーバーの名前に設定します。

MongoDB Atlas 経由で接続する場合は、Server 接続プロパティをプライマリクラスタのシャード値に設定します（例：cluster0-shard-00-00-test.mongodb.net）。シャーディングについての詳細はこちらを参照してください：MongoDB Sharding

MongoDB データベースのポート。

データ型

string

デフォルト値

"27017"

解説

MongoDB データベースのポート。

認証するMongoDB ユーザーアカウントのユーザーID を指定します。

データ型

string

デフォルト値

""

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

認証するユーザーアカウントのパスワードを指定します。

データ型

string

デフォルト値

""

解説

認証サーバーは、ユーザーのID を検証するためにUser とPassword の両方を必要とします。

MongoDB データベース名。

データ型

string

デフォルト値

""

解説

MongoDB データベース名。

このフィールドはSSL が有効化されているかどうかを設定します。

データ型

bool

デフォルト値

true

解説

このフィールドは、Cloud がサーバーとのTLS/SSL 接続をネゴシエートするかどうかを設定します。デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合します。別の証明書を指定するには、SSLServerCert を設定します。

認証のためのMongoDB データベース名。

データ型

string

デフォルト値

""

解説

認証のためのMongoDB データベース名。データを取得するデータベースと認証データベースが異なる場合のみ必要となります。

このプロパティを使うと、 Server および Port で設定されたサーバーに加え、複数のサーバーを指定できます。サーバー名およびポートの両方を、サーバーをカンマで区切って指定します。

データ型

string

デフォルト値

""

解説

このプロパティを使うと、Server およびPort で設定されたサーバーに加え、レプリカセット内の他のサーバーを指定できます。ReplicaSet、Server、およびPort を使用して、レプリカセット内のすべてのサーバーを指定する必要があります。

サーバー名およびポートの両方をReplicaSet に指定します。サーバーはカンマで区切ります。次に例を示します。

Server=localhost;Port=27017;ReplicaSet=localhost:27018,localhost:27019;

プライマリサーバーを見つけるために、Cloud は、ReplicaSet 内のサーバーとServer およびPort で指定されたサーバーをクエリします。

レプリカセット内のプライマリサーバーだけが書き込み可能です。 セカンダリは、SlaveOK の設定が読み取りを許容している場合に読み取りが可能です。セカンダリにSELECT クエリを実行するストラテジーを設定するには、ReadPreference を参照してください。

Specify the DNS server when resolving MongoDB seed list.

データ型

string

デフォルト値

""

解説

Specify the DNS server when resolving MongoDB seed list.

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

データ型

string

デフォルト値

""

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSH プロパティの全リストを提供します。

サービスへのSSH トンネルを確立する際に使用される認証方法。

Possible Values

データ型

string

デフォルト値

"Password"

解説

• None：認証は行われません。現在のSSHUser の値は無視され、接続は匿名でログインされます。
• Password：Cloud は、SSHUser とSSHPassword の値を使用してユーザーを認証します。
• Public_Key：Cloud は、SSHUser とSSHClientCert の値を使用してユーザーを認証します。SSHClientCert には、この認証方法を成功させるために使用可能な秘密鍵が必要です。

SSHUser の認証に使用する証明書。

データ型

string

デフォルト値

""

解説

公開鍵認証を使用するには、SSHClientCert に有効な秘密鍵が含まれている必要があります。 公開鍵はオプションで、含まれていない場合はCloud が秘密鍵から生成します。 Cloud は公開鍵をサーバーに送信し、ユーザーが公開鍵を認証した場合に接続が許可されます。

SSHClientCertType フィールドは、SSHClientCert により指定されたキーストアの種類を指定します。 ストアがパスワードで保護されている場合は、SSHClientCertPassword でパスワードを指定します。

一部の種類のキーストアは、複数のキーを含むことができるコンテナです。 デフォルトでは、Cloud はストアの最初のキーを選択しますが、SSHClientCertSubject を使用して特定のキーを指定することも可能です。

SSHClientCert キーのパスワード（ある場合）。

データ型

string

デフォルト値

""

解説

このプロパティは、証明書ベースの認証を使用する場合のSSH トンネリングに必要です。 SSH 証明書がパスワードで保護されたキーストアにある場合、証明書にアクセスするためにこのプロパティを使用してパスワードを指定します。

SSH クライアント証明書のサブジェクト。

データ型

string

デフォルト値

"*"

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。

それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

SSHClientCert 秘密鍵の種類。

Possible Values

データ型

string

デフォルト値

"PEMKEY_BLOB"

解説

このプロパティには次の値の1つを設定できます。

SSH サーバー。

データ型

string

デフォルト値

""

解説

SSH サーバー。

SSH ポート。

データ型

string

デフォルト値

"22"

解説

SSH ポート。

SSH ユーザー。

データ型

string

デフォルト値

""

解説

SSH ユーザー。

SSH パスワード。

データ型

string

デフォルト値

""

解説

SSH パスワード。

SSH サーバーのフィンガープリント。

データ型

string

デフォルト値

""

解説

SSH サーバーのフィンガープリント。

MongoDB 接続をSSH 経由でトンネリングするかどうか。 SSH を使用します。

データ型

bool

デフォルト値

false

解説

デフォルトでは、Cloud はMongoDB に直接接続しようとします。 このオプションを有効にすると、Cloud は代わりにSSHServer とのSSH 接続を確立し、その接続を経由してMongoDB への接続をトンネリングします。

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

A list of column name mappings for MongoDB's built-in columns.

データ型

string

デフォルト値

""

解説

This property takes a comma-separated list of MongoDB column names for built-in columns and maps them to new names.

The remappable built-in columns are "_index", "P_id" and "_id".

For example:

_index=BuiltInIndex,P_id=Parent_Id,_id=My_Id

Remapping these columns is particularly useful for resolving "column names must be unique" errors that can arise when the Cloud finds additional columns named "_index", "P_id" or "_id" other than the built-in columns.

Specify the compression method. Compression is not enabled when it is None.

Possible Values

データ型

string

デフォルト値

"None"

解説

Specify the compression method. Compression is not enabled when it is None.

By default, the provider will not automatically discover the metadata for a child table as its own distinct table. To enable this functionality, set DataModel to Relational .

Possible Values

データ型

string

デフォルト値

"DOCUMENT"

解説

When setting DataModel to Relational, the discovery of child tables extends to root level elements and those found within top-level array elements. Additionally, the provider exposes _id and parent_id columns to enable JOIN operations between parent and child tables. The _id column acts as a primary key for the flattened table, while the parent_id column identifies the parent document.

デフォルトで、ネスト配列はJSON 文字列として返されます。 FlattenArrays プロパティはネスト配列のエレメントをフラット化してそれぞれのカラムとするために使われます。ネスト配列から返すエレメントの数に FlattenArrays を設定します。

データ型

string

デフォルト値

""

解説

デフォルトで、ネスト配列はJSON 文字列として返されます。FlattenArrays プロパティはネスト配列のエレメントをフラット化してそれぞれのカラムとするために使われます。これは短い配列の場合にのみ推奨されます。

ネスト配列から返すエレメントの数にFlattenArrays を設定します。特定されたエレメントはカラムとして返されます。Zero-base のインデックスはカラム名にコンカテネートされます。他のエレメントは無視されます。

例えば、文字列の配列からエレメントのアービトラリー数を返すことができます。

["FLOW-MATIC","LISP","COBOL"]

FlattenArrays を-1 に設定すると、ネストされた配列のすべてのエレメントをフラット化します。

フラット化されたオブジェクトプロパティとしてカラムを表示するには、 FlattenObjects をtrue に設定します。そうでなければ、配列にネストされたオブジェクトはJSON 文字列として返されます。

データ型

bool

デフォルト値

true

解説

フラット化されたオブジェクトプロパティとしてカラムを表示するには、FlattenObjects をtrue に設定します。そうでなければ、配列にネストされたオブジェクトはJSON 文字列として返されます。カラム名を生成するために、Cloud はプロパティ名をオブジェクト名にドットでコンカティネイトします。

例えば、次のネストされたオブジェクトを接続時にフラット化できます。

[
     { "grade": "A", "score": 2 },
     { "grade": "A", "score": 6 },
     { "grade": "A", "score": 10 },
     { "grade": "A", "score": 9 },
     { "grade": "B", "score": 14 }
]

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してCloud が返す行数の上限を設定します。 この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

サーバーは通常、余分なメモリの使用を防ぐために、インアクティブ期間（10分間）後に、アイドル状態のカーソルをタイムアウトします。これを防ぐために、このオプションを設定します。

データ型

bool

デフォルト値

false

解説

サーバーは通常、余分なメモリの使用を防ぐために、インアクティブ期間（10分間）後に、アイドル状態のカーソルをタイムアウトします。これを防ぐために、このオプションを設定します。

MongoDB から返される、1ページあたりの結果の最大数を指定します。この設定は、ほとんどのユースケースに最適化されている、データソースによって設定されたデフォルトのページサイズをオーバーライドします。

データ型

int

デフォルト値

4096

解説

クエリする特定のオブジェクトやサービスエンドポイントの結果を最適化するために、デフォルトのページサイズを調整したい場合があります。 ページサイズを大きくするとパフォーマンスが向上するかもしれませんが、ページあたりのメモリ消費量が増える可能性もあることに注意してください。

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

レプリカセットから読み取るためのストラテジーに設定します。受容される値は、primary、primaryPreferred、secondary、secondaryPreferred、およびnearest です。

Possible Values

データ型

string

デフォルト値

"primary"

解説

このプロパティを使用すると、プライマリメンバー以外のレプリカセット内のメンバにクエリを実行できるようになります。受容される値は次のとおりです。

• primary：すべてのSELECT クエリが、プライマリサーバーに対して実行されます。
• primaryPreferred：プライマリサーバーが利用できない場合、SELECT クエリはセカンダリサーバーに対して実行されます。
• secondary：すべてのSELECT クエリは、セカンダリサーバーに対して実行されます。
• secondaryPreferred：セカンダリサーバーが利用可能な場合、セカンダリサーバーにSELECT クエリが実行されます。そうでない場合は、プライマリサーバーに対して実行されます。
• nearest：SELECT クエリは、レイテンシが最小のサーバーに対して実行されます。

ReadPreference を使用するタイミング

このプロパティを設定すると、書き込み操作がセカンダリマシンにまだレプリケートされていない場合、最新の変更がクエリ結果に反映されないことがあります。 ReadPreference を使用すると、Cloud が古いデータを返すリスクはありますが、次のことを達成できます。

• フェイルオーバークエリの設定：プライマリサーバーが利用できない場合、このプロパティを"primaryPreferred" に設定すると、オンラインでクエリを実行し続けることができます。
• 地理的に分散したレプリカセットに対してより高速にクエリを実行：デプロイメントで複数のデータセンターが使用されている場合、ReadPreference を"nearest" に設定すると、Cloud はレイテンシが最小のレプリカセットメンバーに対してSELECT クエリを実行するためクエリの処理速度が向上します。

Cloud にSELECT ステートメントをセカンダリサーバーに実行させる場合は、SlaveOK も設定する必要があります。そうしないと、Cloud はエラー応答を返します。

Use this property to target a replica set member or members that are associated with tags.

データ型

string

デフォルト値

""

解説

To make use of ReadPreferenceTags you must configure ReadPreference to a value other than the primary value (the default value). The required format is a list of semicolon seperated tag sets where each tag set is a list of key value pairs separated by commas. For example:

• tag1:val1,tag2:val2;: Find members with both tag values. If none are found, find any eligible member.
• tag1:val1;tag2:val2;: Find members with the specified tag1, otherwise find members with the specified tag2. If none are found find any eligible member.
• tag1:val1: Find only members with the specified tag.
• ;: (semicolon only) Find any eligible member. If left empty, any eligible member is targeted.

The maximum number of rows to scan to look for the columns available in a table.

データ型

int

デフォルト値

100

解説

The columns in a table must be determined by scanning table rows. This value determines the maximum number of rows that will be scanned.

Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.

Setting to a value of -1 causes the Cloud to scan an arbitrary number of rows until it reaches the final row.

Specify the kind of service.

Possible Values

データ型

string

デフォルト値

"MongoDB"

解説

Specify the kind of service.

このプロパティは、provider がセカンダリ（スレーブ）サーバーからの読み込みを認めるかどうかを設定します。

データ型

bool

デフォルト値

false

解説

このプロパティは、Cloud がレプリカセットのセカンダリ（スレーブ）サーバーからの読み込みを認めるかどうかを設定します。 Cloud がReadPreference でセカンダリサーバーをどのようにクエリするかを微調整できます。

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

データ型

int

デフォルト値

60

解説

このプロパティは、Cloud が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。 操作の完了前にタイムアウト時間が経過すると、Cloud は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。 このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

各ドキュメントコレクションのフィールドおよびデータタイプを決定するために、provider がデータをどのようにスキャンするかを示すカンマ区切りのオプション。

Possible Values

データ型

string

デフォルト値

"RowScan"

解説

Sets replacing or merging target document with updating fields is performed by executing update statement.

Possible Values

データ型

string

デフォルト値

"Default"

解説

Sets replacing or merging target document with updating fields is performed by executing update statement. When the default value Default is used, the Cloud updates the target document by replacing the whole original document with new one. When the value is set to Merge, only the specific field in the target document will be updated.

For example, if you have a collection 'classySample' as below.

{
  "_id": "1",
  "message": {
    "component_items": [{"locked": true}],
    "id":1
  }
}

UPDATE [classySample] SET [message.component_items.0.locked] = false  WHERE [message.id] = 1

In the query above, the 'message' document will be replaced with new document constructed with SET clause, the collection after updating looks like

{
  "_id": "1",
  "message": {
    "component_items": [
      {
        "locked": false
      }
    ]
  }
}

But when using Merge, only the 'locked' field in 'component_items' will be updated, the collection becomes

{
    "_id": "1",
    "message": {
        "component_items": [
            {
                "locked": false
            }
        ],
        "id": 1
    }
}

Execute MongoDB queries using db.collection.find().

データ型

bool

デフォルト値

true

解説

Amazon DocumentDB doesn't support the legacy OP_QUERY interface, so this must be set to True to query DocumentDB clusters with db.collection.find() instead.

Requests acknowledgment that the write operation has propagated to the specified number of mongod instances.

データ型

string

デフォルト値

"0"

解説

Requests acknowledgment that the write operation has propagated to the specified number of mongod instances.

Requires acknowledgment that the mongod instances, as specified in the WriteConcern property, have written to the on-disk journal.

データ型

bool

デフォルト値

true

解説

It requests acknowledgment that the mongod instances, as specified in the WriteConcern property, have written to the on-disk journal.

This option specifies a time limit, in milliseconds, for the write concern.

データ型

string

デフォルト値

"0"

解説

This option specifies a time limit, in milliseconds, for the write concern.

Sets whether the object type for inserted or updated objects is determined from the existing column metadata or the input value type.

Possible Values

データ型

string

デフォルト値

"Metadata"

解説

Sets whether the object type for inserted or updated objects is determined from the existing column metadata or the input value type. When the default value Metadata is used, the Cloud uses the data type as determined by the TypeDetectionScheme for objects pushed to MongoDB. When the value is set to RawValue, the type of the object in the INSERT determines what type is used for MongoDB.

For example, if you have a field 'c1' in MongoDB defined as String type, the metadata returns the column as String as well. In the following query, the resulting field in MongoDB is therefore defined as String when using WriteScheme=Metadata. But when using RawValue, the inserting field type is Date instead since the FROM_UNIXTIME() function returns an actual Date object:

INSERT INTO Table1 (c1) VALUES (FROM_UNIXTIME(1636910867039, 0))

Inserting an empty array

INSERT INTO t1 ("c1") VALUES (())

This returns an empty array:

"c1":[]