CData Sync App は、Amazon DynamoDB データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Amazon DynamoDB コネクタはCData Sync アプリケーションから使用可能で、Amazon DynamoDB からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はAmazon DynamoDB REST API のバージョン2012-08-10を使用しています。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
以下を設定してデータに接続します。
IAM ユーザーの認証情報を取得するには:
AWS ルートアカウントの資格情報を取得するには:
アカウントのルートクレデンシャルで認証するには、次のパラメータを設定します。
Note: Amazon discourages using root credentials for anything beyond simple testing. The account root credentials have the full permissions of the user, posing a security risk and making this the least secure authentication method.
多要素認証が必要な場合は、以下を指定します。
Note: 一時的な認証情報の有効期間(デフォルトは3600秒)を制御するには、TemporaryTokenDuration プロパティを設定します。
一時クレデンシャルで認証するには、次を設定します。
Sync App は、一時クレデンシャルの有効期間中、長期的な認証情報(IAM ユーザー認証情報など)によって提供されるものと同じ権限を使用してリソースをリクエストできるようになりました。
一時クレデンシャルおよびIAM ロールの両方を使用して認証するには、上記のすべてのパラメータを設定し、さらに以下のパラメータを指定します。
多要素認証が必要な場合は、以下を指定します。
Note: 一時的な認証情報の有効期間(デフォルトは3600秒)を制御するには、TemporaryTokenDuration プロパティを設定します。
AuthScheme をAwsEC2Roles に設定します。
EC2 インスタンスからSync App を使用していて、そのインスタンスにIAM ロールが割り当てられている場合は、 認証にIAM ロールを使用できます。Sync App は自動的にIAM ロールの認証情報を取得し、それらを使って認証するため、AWSAccessKey およびAWSSecretKey を指定する必要はありません。
認証にIAM ロールも使用している場合は、さらに以下を指定する必要があります。
Amazon DynamoDB Sync App は、IMDSv2 をサポートしています。IMDSv1 とは異なり、新バージョンでは認証トークンが必須です。エンドポイントおよびレスポンスは、両バージョンで同じです。
IMDSv2 では、Amazon DynamoDB Sync App はまずIMDSv2 メタデータトークンの取得を試み、それを使用してAWS メタデータエンドポイントを呼び出します。トークンを取得できない場合、Sync App はIMDSv1 を使用します。
AuthScheme をAwsWebIdentity に設定します。
Web ID でロールを割り当てられるように構成されたコンテナ(OpenID Provider を持つEKS クラスタ内のPod など)からAmazon DynamoDB を使用する場合、またはIAM ロールに関連付けられたWeb ID プロバイダーで認証する場合(ID トークンを取得する場合)、Web ID トークンとIAM ロールの情報を一時的なセキュリティ認証情報と交換し、AWS サービスを認証してアクセスすることができます。
コンテナの環境変数にAWS_ROLE_ARN とAWS_WEB_IDENTITY_TOKEN_FILE が指定されている場合、Amazon DynamoDB は自動的に認証情報を取得します。
AWSRoleARN とAWSWebIdentityToken の両方を指定することで、AssumeRoleWithWebIdentity API 操作を実行して認証することもできます。
AWS ロールとして認証するには、次のプロパティを設定します。
多要素認証が必要な場合は、以下を指定します。
Note: 一時的な認証情報の有効期間(デフォルトは3600秒)を制御するには、TemporaryTokenDuration プロパティを設定します。
Note:状況によっては、AWS ルートユーザーのダイレクトなセキュリティ認証情報よりも、IAM ロールを使用して認証する方が望ましい場合があります。AWS ルートユーザーのAWSAccessKey およびAWSSecretKey を指定している場合、ロールは使用できません。
ADFS に接続するには以下のプロパティを設定します。
接続文字列の例:
AuthScheme=ADFS; AWSRegion=Ireland; [email protected]; Password=CH8WerW121235647iCa6; SSOLoginURL='https://adfs.domain.com'; AWSRoleArn=arn:aws:iam::1234:role/ADFS_SSO; AWSPrincipalArn=arn:aws:iam::1234:saml-provider/ADFSProvider; S3StagingDirectory=s3://athena/staging;
ADFS 統合フローでは、現在Windows にログインしているユーザーの資格情報を使用して接続します。 ADFS 統合フローを使用するには、User およびPassword を指定せず、それ以外の設定は上記のADFS に記載された手順に従ってください。
Okta に接続するには以下のプロパティを設定します。
Okta クライアントリクエストコンテキストをオーバーライドする信頼されたアプリケーションまたはプロキシのいずれかを使用する場合、またはMFA を設定している場合は、Okta を使用して認証するためにSSOProperties を組み合わせて使用する必要があります。必要に応じて、以下のいずれかを設定します。
接続文字列の例:
AuthScheme=Okta; AWSRegion=Ireland; [email protected]; Password=CH8WerW121235647iCa6; SSOLoginURL='https://cdata-us.okta.com/home/amazon_aws/0oa35m8arsAL5f5NrE6NdA356/272'; SSOProperties='ApiToken=01230GGG2ceAnm_tPAf4MhiMELXZ0L0N1pAYrO1VR-hGQSf;'; AWSRoleArn=arn:aws:iam::1234:role/Okta_SSO; AWSPrincipalARN=arn:aws:iam::1234:saml-provider/OktaProvider; S3StagingDirectory=s3://athena/staging;
SSOLoginURL 用の相互SSL 認証(WS-Trust STS エンドポイント)を有効化するには、次の SSOProperties を設定します。
接続文字列の例:
authScheme=pingfederate;SSOLoginURL=https://mycustomserver.com:9033/idp/sts.wst;SSOExchangeUrl=https://us-east-1.signin.aws.amazon.com/platform/saml/acs/764ef411-xxxxxx;user=admin;password=PassValue;AWSPrincipalARN=arn:aws:iam::215338515180:saml-provider/pingFederate;AWSRoleArn=arn:aws:iam::215338515180:role/SSOTest2;
認証には、AccessKey / SecretKey 認証、一時クレデンシャル、ロール認証、またはMFAに関連する設定を含む、任意のクレデンシャルファイルを使用できます。
このためには、以下のプロパティを設定します。
AWS Cognito のユーザープールに登録されたユーザーでSync App を使用する場合は、以下のプロパティを設定します。
次のプロパティを使って、自動データ型検出を設定できます。デフォルトは有効です。
次のプロパティを使って、Amazon DynamoDB API 機能およびSync App のストラテジーをさらに制御できます。
UseSimpleNames:Amazon DynamoDB は、多くのデータベース指向のツールがサポートしていない特殊文字を使った属性名をサポートしています。
加えて、Amazon DynamoDB のテーブル名にはドットおよびダッシュを含めることができます。Sync App はテーブル名内のドットを階層区切りとして解釈し、XPath と同じようにネストされたフィールドをドリルダウンできます。
このプロパティを使用すると、英数字以外の文字をアンダースコアで置き換えられます。
次のプロパティを設定すると、"maximum throughput exceeded" などの一時的なエラーを返す代わりに、クエリを再試行できます。
また、CData Sync App には、クエリに応じて使い分けることができるPartiQL とScan という2つの独立したAPI があります。使用されるAPI は、実行されるクエリによって異なります。
Pagesize プロパティを使うと、アイテムのサイズおよびAmazon DynamoDB の1MB のページサイズを基に、プロビジョニングされたスループットの使用を最適化できます。このプロパティを、返すアイテム数に設定します。
一般的に、ページサイズが小さくなると、スロットルの原因となるスループットのスパイクが低減します。また、リクエスト間にポーズも挿入されます。この間隔はリクエストのディストリビューションを均等化し、スロットルを回避することでより多くのリクエストを成功するようにします。
ThreadCount 接続プロパティを設定することで、Scan リクエスト実行時に使用するスレッド数を変更できます。使用するスレッド数が増えると、より多くのメモリが使用されますが、各スレッドの結果はより速くなります。 デフォルトは4です。この機能は、高スループットまたは変動するスループットがプロビジョニング済みのテーブルに最適です。
単一のスレッドでテーブルの最大スループットを超えてしまうようなケースでは、シングルスレッドのPartiQL API よりもScan を使うメリットはありません。 Amazon DynamoDB は、最大スループットを超えなくなるまで、すべてのスレッドを単純に制御します。
カスタムIAM ポリシーを作成するよりも、定義済みのロールをサービスに使用することを推奨します。Amazon DynamoDB の事前定義されたロールは次のとおりです。
| IAM ロール | 説明 | |
| dynamodb:ListTables | DynamoDB テーブルのリストを取得するために必要です。メタデータの取得時に使用され、テーブルのリストを動的に決定します。このアクションはリソースレベルのアクセス許可をサポートしていないため、All resources を選択する必要があることに注意してください("Resource" の * はそのためです)。 言い換えると、dynamodb:ListTables アクションは* Resource を必要とし、他のアクションはすべてのテーブルarn:aws:dynamodb:us-east-1:987654321098:table/* または特定のテーブルのリストに対してアクセス許可を与えることができます。
"Resource": [
"arn:aws:dynamodb:us-east-1:987654321098:table/Customers",
"arn:aws:dynamodb:us-east-1:987654321098:table/Orders"
] | |
| dynamodb:DescribeTable | 選択したテーブルのメタデータを取得するために必要です。テーブルのメタデータの取得時に使用され、カラムのリストを動的に決定します。このアクションはリソースレベルのアクセス許可をサポートしているため、メタデータを取得したいテーブルを指定できます。たとえば、リージョンがNorthern Virginia でus-east-1、アカウントが987654321098 のCustomers およびOrders のテーブルの場合:
{
"Effect": "Allow",
"Action": [
"dynamodb:DescribeTable"
],
"Resource": [
"arn:aws:dynamodb:us-east-1:987654321098:table/Customers",
"arn:aws:dynamodb:us-east-1:987654321098:table/Orders"
]
}
接続プロパティAWSRegion で指定したリージョンのすべてのテーブルにアクセス許可を与えるには、テーブル名の代わりに * を使用します: "Resource": "arn:aws:dynamodb:us-east-1:987654321098:table/*" | |
| dynamodb:Scan | テーブルのすべての項目にアクセスして1つ以上の項目を取得するために必要です。たとえば、SELECT * FROM [Customers] のように、ほとんどのSELECT クエリに使用されます。このアクションはリソースレベルのアクセス許可をサポートしているため、dynamodb:DescribeTable と同様に、データを取得したいテーブルを指定できます。 | |
| dynamodb:PartiQLSelect | SELECT クエリを使用して主キーカラムでフィルタリングする際に、テーブルから特定の項目を取得するために必要です。たとえば、SELECT * FROM [Customers] WHERE id=1234 です。このアクションはリソースレベルのアクセス許可をサポートしているため、dynamodb:DescribeTable と同様に、データを取得したいテーブルを指定できます。 | |
| dynamodb:PartiQLInsert | テーブルにデータを挿入するために必要です。このアクションはリソースレベルのアクセス許可をサポートしているため、dynamodb:DescribeTable と同様に、データを挿入したいテーブルを指定できます。 | |
| dynamodb:PartiQLUpdate | テーブルのデータを変更するために必要です。このアクションはリソースレベルのアクセス許可をサポートしているため、dynamodb:DescribeTable と同様に、データを変更したいテーブルを指定できます。 | |
| dynamodb:PartiQLDelete | テーブルからデータを削除するために必要です。このアクションはリソースレベルのアクセス許可をサポートしているため、dynamodb:DescribeTable と同様に、データを削除したいテーブルを指定できます。 | |
| dynamodb:CreateTable | テーブルの作成に必要です。このアクションはリソースレベルのアクセス許可をサポートしているため、作成できるテーブル名を指定できます。 |
Amazon DynamoDB はスキーマレスなドキュメントデータベースで、高いパフォーマンス、使用性、およびスケーラビリティを提供します。これらの機能は、必ずしもSQL-92 のような標準準拠のクエリ言語と互換しないわけではありません。このセクションでは、Sync App が複数のやり方によって、リレーショナルSQL とドキュメントデータベースのギャップの橋渡しをいかに行うかを説明します。
Sync App では、スキーマレスなAmazon DynamoDB テーブルをリレーショナルテーブルにモデル化し、SQL クエリをAmazon DynamoDB クエリに読み替えることで、要求されたデータを取得します。
自動スキーマ検出 スキームでは、設定された行数のテーブルをスキャンすることで、自動的にAmazon DynamoDB テーブル内のデータ型を見つけます。Amazon DynamoDB テーブルのリレーショナル表現をコントロールするためにRowScanDepth、FlattenArrays、およびFlattenObjects を使うことができます。
Sync App は、コレクション内のAmazon DynamoDB ドキュメントをサンプルとして調べ、リレーショナルスキーマを提案します。RowScanDepth プロパティを使って、Sync App がスキャンするドキュメント数を設定することができます。検出プロセスで特定されるカラムは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
}
このドキュメントは次のカラムにより表されます:
| カラム名 | データ型 | サンプル値 |
| id | Integer | 12 |
| name | String | Lohia Manufacturers Inc. |
| address.street | String | Main Street |
| address.city | String | Chapel Hill |
| address.state | String | NC |
| offices | String | ["Chapel Hill", "London", "New York"] |
| annual_revenue | Double | 35,600,000 |
FlattenObjects が設定されていない場合、address.street、address.city、およびaddress.state カラムは別々にはなりません。文字列型の住所カラムは一つのオブジェクトとして表されます。値は次のようになります {street:"Main Street", city:"Chapel Hill", state:"NC"}。JSON アグリゲートの詳細についてはJSON 関数 を参照してください。
カラム名の区切り文字をドットから変更するには、SeparatorCharacter を設定します。
FlattenArrays プロパティは配列の値をフラット化してそれぞれのカラムとするために使われます。これは次の例のように短い配列の場合にのみ推奨されます。
"coord": [ -73.856077, 40.848447 ]FlattenArrays プロパティは2に設定して上の配列を次のように表すことができます:
| カラム名 | データ型 | サンプル値 |
| coord.0 | Float | -73.856077 |
| coord.1 | Float | 40.848447 |
アンバウンドの配列をそのままにしておき、必要な際にJSON 関数 を使ってデータを取り出すことをお勧めします。
オブジェクトの配列を、個別のテーブルのように取得することが可能です。例えば、restaurants テーブルから次のJSON 構造を取得します。
{
"restaurantid" : "30075445",
"address" : {
"building" : "1007",
"coord" : [-73.856077, 40.848447],
"street" : "Morris Park Ave",
"zipcode" : "10462"
},
"borough" : "Bronx",
"cuisine" : "Bakery",
"grades" : [{
"date" : 1393804800000,
"grade" : "B",
"score" : 2
}, {
"date" : 1378857600000,
"grade" : "A",
"score" : 6
}, {
"date" : 1358985600000,
"grade" : "A",
"score" : 10
}],
"name" : "Morris Park Bake Shop"
}
垂直フラット化では、以下の構文を使用することでgrades 配列を別々のテーブルとして取得することを許可します。
SELECT * FROM [restaurants.grades]このクエリは、次のデータセットを返します。
| date | grade | score | _index |
| 1393804800000 | B | 2 | 1 |
| 1378857600000 | A | 6 | 2 |
| 1358985600000 | A | 10 | 3 |
SELECT * FROM [restaurants.cuisine.bakery.grades]また、ネスト構造にさらに上の階層の配列が含まれている場合もあります。次のJSON を例として考えてみましょう。
{
"restaurantid" : "30075445",
"reviews": [
{
"grades": [
{
"date": 1393804800000,
"score": 2,
"grade": "B"
},
{
"date": 1378857600000,
"score": 6,
"grade": "A"
},
{
"date": 1358985600000,
"score": 10,
"grade": "A"
}]
}],
"name" : "Morris Park Bake Shop"
}
この構造では、reviews 配列のインデックスを角かっこで囲む必要があります。SQL クエリですでにエスケープ文字列として使用されている場合は、以下のクエリのように、角かっこ自体をエスケープする必要があります。
SELECT * FROM [restaurants.reviews.\[0\].grades]このクエリは、上部のJSON 構造と同じデータセットを返します。この構文は大文字小文字を区別しますので、フィールド名はDynamoDB に保存されているのと同じように記述するよう注意してください。
Sync App では、JSON ストラクチャーをカラム値として返すことができます。Sync App を使って、これらのJSON ストラクチャーにおいて標準SQL 関数を使用できます。このセクションの例では、次の配列を使用します。
[
{ "grade": "A", "score": 2 },
{ "grade": "A", "score": 6 },
{ "grade": "A", "score": 10 },
{ "grade": "A", "score": 9 },
{ "grade": "B", "score": 14 }
]
SELECT Name, JSON_EXTRACT(grades,'[0].grade') AS Grade, JSON_EXTRACT(grades,'[0].score') AS Score FROM Students;
| カラム名 | サンプル値 |
| Grade | A |
| Score | 2 |
SELECT Name, JSON_COUNT(grades,'[x]') AS NumberOfGrades FROM Students;
| カラム名 | サンプル値 |
| NumberOfGrades | 5 |
SELECT Name, JSON_SUM(score,'[x].score') AS TotalScore FROM Students;
| カラム名 | サンプル値 |
| TotalScore | 41 |
SELECT Name, JSON_MIN(score,'[x].score') AS LowestScore FROM Students;
| カラム名 | サンプル値 |
| LowestScore | 2 |
SELECT Name, JSON_MAX(score,'[x].score') AS HighestScore FROM Students;
| カラム名 | サンプル値 |
| HighestScore | 14 |
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 }
Amazon DynamoDB はNoSQL データソースであり、クエリも標準的なリレーショナルデータベースとは異なるハンドリングが必要です。
カラムにデータ型の指定がないということは、一つのカラムに異なるデータ型を格納することができるということです。例として、ある行にはEmailAddress という文字列が格納され、他の行は同じくEmailAddress というStringSet が格納されることができます。これらや他のケースでは、Sync App がクエリにおいて値によってどのデータ型を使用すべきかを判断します。
例として、PartNumber が文字列、もしくは数値のどちらでも格納できるItem テーブルがあります。Number値である12345 をPartNumber の部分を取得するには、次のクエリを使います:
SELECT Name, Location, Quantity, PartNumber FROM Items WHERE PartNumber = 12345
他の方法として、PartNumber は文字列 "12345" として格納することもできます。文字列値である12345 をPartNumber の部分を取得するには、次のクエリを使います:
SELECT Name, Location, Quantity, PartNumber FROM Items WHERE PartNumber = '12345'特定の値のデータタイプがどちらとも取れるものでない場合には、自動検出のデータタイプの前に使われます。どちらの場合にも、パラメータはハードコードされた値の代わりに使われていて、パラメータのデータ型がAmazon DynamoDB に渡されるデータ型を決定するのに使われています。
データ型検出だけでは値が明確ではない場合には、Sync App は自動検出されたカラムと比較します。Location テーブルにCoordinates というカラムを挿入したい場合には、INSERT は次のようになります:
INSERT INTO Locations (Address, Coordinates) VALUES ('123 Fake Street', '[40.7127, 74.0059]')
インプット値だけでは、検出されるデータ型は文字列です。但し、Coordinates カラムは以前に自動検出されており、Sync App は単なるstring ではなくNumberSet を挿入します。
Coordinates カラムがLocations テーブルをスキャンした際に自動検出されていなかった場合には、挿入された値のデータ型が使われます。
この場合にもINSERT がNumberSet であることを解決することができますが、いくらか難解な作業が必要です。
Amazon DynamoDB supports 2 different methods of of using the COUNT aggregate function.To simply return the number of Items in you table, issue the following query:
SELECT COUNT(*) FROM MyTableThe CData Sync App will read the ItemCount from the DescribeTable Action.This avoids using too many read units to scan the full table.However, DynamoDB updates this value approximately every six hours and recent changes might not be reflected in this value.
Issuing the below example queries will instead scan the full table for count:
SELECT COUNT(*) FROM MyTable WHERE MyInt > 10 SELECT COUNT(MyInt) FROM MyTable
Amazon DynamoDB ドキュメントおよびリストがCData Sync App でサポートされます。ルートレベルでドキュメントとリストに直接アクセスするか、'.' 記号を階層ディバイダーとして使ってドキュメントやリストをドリルダウンすることができます。
データタイプが自動検出される場合、信頼して検出できる一番低いレベルまでレポートされます。例として、Customer というドキュメントにAddress という子があり、そのAddress にStreet という子があるものは、Customer.Address.Street というカラムで表現されます。
但し、このプロセスはリストには当てはまりません。これはリストへのエントリ数は決まっていないからです。リストもしくはセットが検出された場合には、追加の値はテーブルスキーマで利用可能なものとしてはレポートされません。
もし属性で頻繁に値がなく、自動検出されないものがある場合にも、正しいパスを指定することで取得が可能です。例として、特別な属性をCustomer ドキュメントから取得する:
SELECT [Customer.Address.Street], [Customer.Special] FROM MyTableリストが検出された場合には、追加の値はレポートされません。ただしリストの個別の値はnumber で'.' を指定することでリファレンスできます。次に例を示します。
SELECT [MyList.0], [MyList.1.Email], [MyList.1.Age] FROM MyTableこれは、リストの最初の値と、2つ目の値のEmail とAge 属性を取得します。
Amazon DynamoDB のINSERT には、フルオブジェクトを指定する必要があります。ドキュメントもしくはリストのルートでの挿入(INSERT)フルJSON アグリゲートのパス次に例を示します。
INSERT INTO MyTable (PrimaryKey, EmailAddresses, Address, MyList) VALUES ('uniquekey', '["[email protected]", "[email protected]"]', '{"Street":"123 Fake Street", "City":"Chapel Hill", "Zip":"27713"}', '[{"S":"somestr"},{"NS":[1,2]},{"N":4}]')
このケースでは、EmailAddress はStringSet として挿入され、Address はドキュメントとして挿入され、MyList はリストとして挿入されます。
更新(UPDATE) はSELECT で利用可能なものと同じシンタックスを使ってサポートされます。ドキュメントおよびリストは階層を指定する'.' 記号を使って指定できます。次に例を示します。
UPDATE MyTable SET [EmailAddress.0]='[email protected]', [EmailAddress.1]='[email protected]', [Address.Street]='123 Fake Street', [Address.City]='Chapel Hill', [Address.Zip]='27713', [MyList.0]='somestr', [MyList.1]='[1,2]', [MyList.2]=4 WHERE PrimaryKey='uniquekey'注意すべき点として、EmailAddress およびMyList は、EmailAddress をMyList とは別に扱う問題を解決するために、自動検出されなければなりません。もし自動検出がされるかに確信がない場合には、更新にフルJSON を指定すればいつでも機能します。
Sync App は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。さらに、IgnoreTypes 接続プロパティに基づいて返される利用可能なデータのスキャンを試みます。 以下のテーブルはこれらのマッピングを説明します。
| Amazon DynamoDB | CData スキーマ |
| String | string、date、datetime、time |
| Binary | string |
| Number | bigint、int、float(検出されるデータに応じて) |
| StringSet | string |
| NumberSet | string |
| BinarySet | string |
| Map | string |
| List | string |
| Boolean | bool |
| Null | string |
Note that depending on the settings of IgnoreTypes, some of these types may not be detected by default.Date, datetime, and time for example are ignored by default as they cannot be filtered server side, and may be inserted / updated in a different format than your existing entries if enabled.Please use caution when enabling them.
FlattenArrays and FlattenObjects may also be used to to flatten the StringSets, NumberSets, BinarySets, Maps, and Lists into indivudal columns.
自動スキーマ検出 に加え、Sync App ではAmazon DynamoDB テーブルのスキーマを統計的に定義することができます。レストランのデータセットのスキーマを考えてみましょう。
テーブルからの例としてのアイテムは以下のとおり:
{
"address":{
"building":"461",
"coord":[
-74.138492,
40.631136
],
"street":"Port Richmond Ave",
"zipcode":"10302"
},
"borough":"Staten Island",
"cuisine":"Other",
"grades":[
],
"name":"Indian Oven",
"restaurant_id":"50018994"
}
次のスキーマは、other:path プロパティを使って、特定のカラムへのデータがどこに取得されるべきかを定義します。このモデルを使って、階層構造のアービトラリーレベルをフラット化することができます。
'other:tableapiname' 属性は、パースするテーブルを指定します。この属性は同じテーブルに対して複数のスキーマを使うフレキシビリティを与えます。
カスタムスキーマ例 では、上の例を含む完全なスキーマを確認できます。
<api:info title="StaticRestaurants" other:catalog="CData" other:schema="AmazonDynamoDB" description="StaticRestaurants" other:tableapiname="StaticRestaurants" other:version="20">
<attr name="id" xs:type="decimal" key="true" columnsize="17" precision="38" scale="6" readonly="false" description="Dynamic Column." other:dynamodatatype="N" other:relativepath="restaurant_id" other:filterable="true" other:fullpath="restaurant_id" other:apiname="&quot;restaurant_id&quot;" />
<attr name="borough" xs:type="string" columnsize="2000" readonly="false" description="Dynamic Column." other:dynamodatatype="S" other:relativepath="borough" other:filterable="true" other:fullpath="borough" other:apiname="&quot;borough&quot;" />
<attr name="address_zipcode" xs:type="int" columnsize="4" precision="10" readonly="false" description="Dynamic Column." other:dynamodatatype="S" other:relativepath="zipcode" other:filterable="true" other:fullpath="address.zipcode" other:apiname="&quot;address&quot;.&quot;zipcode&quot;" />
<attr name="address_coord_0" xs:type="double" columnsize="8" precision="15" readonly="false" description="Dynamic Column." other:dynamodatatype="N" other:relativepath="coord" other:filterable="true" other:fullpath="address.coord[0]" other:apiname="&quot;address&quot;.&quot;coord&quot;[0]" />
<attr name="address_coord_1" xs:type="double" columnsize="8" precision="15" readonly="false" description="Dynamic Column." other:dynamodatatype="N" other:relativepath="coord[1]" other:filterable="true" other:fullpath="address.coord[1]" other:apiname="&quot;address&quot;.&quot;coord&quot;[1]" />
<attr name="address_building" xs:type="int" columnsize="4" precision="10" readonly="false" description="Dynamic Column." other:dynamodatatype="S" other:relativepath="building" other:filterable="true" other:fullpath="address.building" other:apiname="&quot;address&quot;.&quot;building&quot;" />
<attr name="address_street" xs:type="string" columnsize="2000" readonly="false" description="Dynamic Column." other:dynamodatatype="S" other:relativepath="street" other:filterable="true" other:fullpath="address.street" other:apiname="&quot;address&quot;.&quot;street&quot;" />
<attr name="name" xs:type="string" columnsize="2000" readonly="false" description="Dynamic Column." other:dynamodatatype="S" other:relativepath="name" other:filterable="true" other:fullpath="name" other:apiname="&quot;name&quot;" />
<attr name="cuisine" xs:type="string" columnsize="2000" readonly="false" description="Dynamic Column." other:dynamodatatype="S" other:relativepath="cuisine" other:filterable="true" other:fullpath="cuisine" other:apiname="&quot;cuisine&quot;" />
</api:info>
このセクションには、完全なスキーマが含まれています。インフォセクションではAmazon DynamoDB テーブルのリレーショナルビューを可能にします。詳細はカスタムスキーマ定義 を参照してください。次のテーブルではSELECT、INSERT、UPDATE、およびDELETE コマンドが以下のスキーマのGET、POST、MERGE、およびDELETE セクションとして実行されます。Location プロパティをスキーマファイルを格納するファイルディレクトリに設定します。
'other:tableapiname' 属性を使って、パースするテーブル名を特定します。'other:tableapiname' 属性を使って、同じコレクションに対して複数のスキーマを定義することができます。 Note: Amazon DynamoDB は大文字・小文字の区別が必要です。テーブル名および指定されたパスは、Amazon DynamoDB においてフィールドが現れる際の大文字・小文字に合致している必要があります。
dynamodbadoProviderOperationCaller のような処理は内部の実行であり、as-is でコピーできます。
<api:script xmlns:api="http://apiscript.com/ns?v1" xmlns:xs="http://www.cdata.com/ns/rsbscript/2" xmlns:other="http://apiscript.com/ns?v1">
<api:info title="StaticRestaurants" other:catalog="CData" other:schema="AmazonDynamoDB" description="StaticRestaurants" other:tableapiname="StaticRestaurants" other:version="20">
<attr name="id" xs:type="decimal" key="true" columnsize="17" precision="38" scale="6" readonly="false" description="Dynamic Column." other:dynamodatatype="N" other:relativepath="restaurant_id" other:filterable="true" other:fullpath="restaurant_id" other:apiname="&quot;restaurant_id&quot;" />
<attr name="borough" xs:type="string" columnsize="2000" readonly="false" description="Dynamic Column." other:dynamodatatype="S" other:relativepath="borough" other:filterable="true" other:fullpath="borough" other:apiname="&quot;borough&quot;" />
<attr name="address_zipcode" xs:type="int" columnsize="4" precision="10" readonly="false" description="Dynamic Column." other:dynamodatatype="S" other:relativepath="zipcode" other:filterable="true" other:fullpath="address.zipcode" other:apiname="&quot;address&quot;.&quot;zipcode&quot;" />
<attr name="address_coord_0" xs:type="double" columnsize="8" precision="15" readonly="false" description="Dynamic Column." other:dynamodatatype="N" other:relativepath="coord" other:filterable="true" other:fullpath="address.coord[0]" other:apiname="&quot;address&quot;.&quot;coord&quot;[0]" />
<attr name="address_coord_1" xs:type="double" columnsize="8" precision="15" readonly="false" description="Dynamic Column." other:dynamodatatype="N" other:relativepath="coord[1]" other:filterable="true" other:fullpath="address.coord[1]" other:apiname="&quot;address&quot;.&quot;coord&quot;[1]" />
<attr name="address_building" xs:type="int" columnsize="4" precision="10" readonly="false" description="Dynamic Column." other:dynamodatatype="S" other:relativepath="building" other:filterable="true" other:fullpath="address.building" other:apiname="&quot;address&quot;.&quot;building&quot;" />
<attr name="address_street" xs:type="string" columnsize="2000" readonly="false" description="Dynamic Column." other:dynamodatatype="S" other:relativepath="street" other:filterable="true" other:fullpath="address.street" other:apiname="&quot;address&quot;.&quot;street&quot;" />
<attr name="name" xs:type="string" columnsize="2000" readonly="false" description="Dynamic Column." other:dynamodatatype="S" other:relativepath="name" other:filterable="true" other:fullpath="name" other:apiname="&quot;name&quot;" />
<attr name="cuisine" xs:type="string" columnsize="2000" readonly="false" description="Dynamic Column." other:dynamodatatype="S" other:relativepath="cuisine" other:filterable="true" other:fullpath="cuisine" other:apiname="&quot;cuisine&quot;" />
</api:info>
<api:script method="GET">
<api:call op="dynamodbadoProviderOperationCaller">
<api:push/>
</api:call>
</api:script>
<api:script method="POST">
<api:call op="dynamodbadoProviderOperationCaller">
<api:push/>
</api:call>
</api:script>
<api:script method="MERGE">
<api:call op="dynamodbadoProviderOperationCaller">
<api:push/>
</api:call>
</api:script>
<api:script method="DELETE">
<api:call op="dynamodbadoProviderOperationCaller">
<api:push/>
</api:call>
</api:script>
</api:script>
このセクションでは、Amazon DynamoDB Sync App の高度な機能を厳選して説明します。
Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
詳しくは、クエリ処理 を参照してください。
デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
Amazon DynamoDB は、拡張性の高いNoSQL クラウドデータベースであり、通常のデータベースとは動作が異なります。CData Sync App は、標準データベースと同様のインターフェースを使用してAmazon DynamoDB データにアクセスできます。以下のトピックでは、スキーマレスなAmazon DynamoDB テーブルをどのようにして標準のテーブル およびストアドプロシージャ にモデル化しているかを説明します。
テーブル のリストはAmazon DynamoDB アカウントから動的に取得されます。CreateTable ストアドプロシージャを使用してテーブルを作成できます。Amazon Web サービスAdmin コンソールを使用してテーブルを作成することもできます。
Sync App は接続時にテーブルスキーマを動的に検出できます。詳しくは、自動スキーマ検出 を参照してください。このメソッドはデータ構造が揮発性の場合に便利です。
テーブルのリストはAmazon DynamoDB アカウントから動的に取得されます。 ストアドプロシージャを使って、新しいテーブルを作成できます。Amazon Web サービスAdmin コンソールを使ってテーブルを作成することもできます。
DynamoDB テーブルはキーに基づいて仕切られているため、テーブルのクエリ要件に基づいて正しいキーを選択するように気を付けなければなりません。DynamoDB テーブルにデータをモデル化するベストプラクティスの使用については、DynamoDB のドキュメントを参照してください。DynamoDB は二種類のプライマリキーをサポートします。
Amazon DynamoDB テーブルはスキーマレスであり、Sync App では以下の二つの方法でスキーマをアンカバーします。
テーブルのカラムは最初の数行をスキャンすることで動的に決定されます。RowScanDepth プロパティを変更することで、スキャンする行数を調節することができます。カラム名のほかに、行スキャンがデータ型を決定します。次のテーブルは、どのようにAmazon DynamoDB でサポートされている異なるデータ型がSync App においてモデル化されているかを説明します。
| Amazon DynamoDB 型 | モデル化された型 | エンコーディング | サンプル値 | |
| Boolean | Boolean | Not Required | True | |
| String | String | Not Required | USA | |
| Blob | String | Not Required | ||
| Number | Double | Not Required | 24.0 | |
| String Array | String | JSON Array | ["USA","Canada","UK"] | |
| Number Array | String | JSON Array | [20,200.5,500] | |
| Blob Array | JSON Array | JSON Array | ["ABCD","EFGH"] | |
| Document | JSON Object | JSON Object | {"Address":"123 Fake Street","City":"Chapel Hill","Zip":"27516"} | |
| List | JSON Array | JSON Array | [{"S":"mystring"},{"NS":[1,2]},{"N":4}] |
動的に組成されるスキーマを使う代わりに、自分でスキーマを定義することも可能です。これにより、射影されるカラムを管理できるほか、boolean、datetime など、別のデータ型を使用することができます。独自のスキーマを作成するには、CreateSchema ストアドプロシージャを参照してください。新しいスキーマファイルのFileName(フルパス)およびTableName を、Amazon DynamoDB テーブルの名前に合致するように指定し、カラムリストを編集し、お客様自身のテーブルとして利用します。
テーブルスキーマはメタデータを報告する際に必要ですが、データの選択、挿入、更新、削除ではスキーマに存在しないカラムからのデータが扱われることがあります。まだスキーマテーブルが存在していないカラムのデータ型は、指定されたデータに基づいて動的に決定されます。詳しくは、DynamoDB クエリ を参照してください。
ストアドプロシージャはファンクションライクなインターフェースで、Amazon DynamoDB の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずSync App の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにAmazon DynamoDB から関連するレスポンスデータを返します。
| Name | Description |
| CreateTable | Creates a new table in DynamoDB with specified partition and sort keys, along with optional billing mode and capacity settings. |
Generates a schema file for a specified table or view, detailing its structure and attributes for use in DynamoDB operations.
データモデル内の既存のテーブルまたはビューからローカルスキーマファイル(.rsd)を作成します。
スキーマファイルは、このプロシージャが実行されると、Location 接続プロパティで設定されたディレクトリに作成されます。ファイルを編集してカラムを含めたり除外したり、カラム名を変更したり、カラムのデータ型を変更したりできます。
Sync App はLocation を確認し、.rsd ファイルの名前がデータモデルのテーブルまたはビューに一致するかどうかを判断します。重複がある場合、スキーマファイルはデータモデル内のこのテーブルのデフォルトインスタンスよりも優先されます。既存のテーブルまたはビューに一致しないスキーマファイルがLocation に存在する場合、新しいテーブルまたはビューのエントリがSync App のデータモデルに追加されます。
| Name | Type | Required | Description |
| TableName | String | True | Specifies the name of the table or view for which the schema is being created. This is a required input for schema generation. |
| FileName | String | False | The full file path and name where the generated schema will be saved. If not provided, the schema will be returned in the FileData output instead. 'C:\\Users\\User\\Desktop\\table.rsd' |
| Name | Type | Description |
| Result | String | Indicates whether the schema creation was successful or failed. Possible values are 'Success' or 'Failure'. |
| FileData | String | The generated schema encoded in Base64 format. This output is only provided when FileName is not specified, allowing the schema to be handled programmatically. |
Creates a new table in DynamoDB with specified partition and sort keys, along with optional billing mode and capacity settings.
| Name | Type | Required | Description |
| TableName | String | True | The name of the table to create, which must be between 3 and 255 characters. This is a required parameter for table creation. |
| PartitionKeyName | String | True | Specifies the name of the partition key, which is mandatory for uniquely identifying items in the table. |
| PartitionKeyType | String | True | Defines the data type of the partition key, such as 'String', 'Number', or 'Binary'. This determines how the partition key will be stored and indexed.
使用できる値は次のとおりです。S, N, B |
| SortKeyName | String | False | Specifies the name of the sort key, which is optional and used for secondary organization of data within a partition. |
| SortKeyType | String | False | Defines the data type of the sort key, such as 'String', 'Number', or 'Binary', if a sort key is provided.
使用できる値は次のとおりです。S, N, B |
| BillingMode | String | False | Specifies how you are billed for throughput capacity. Options include 'PROVISIONED' for manual capacity management or 'PAY_PER_REQUEST' for on-demand scaling.
使用できる値は次のとおりです。PROVISIONED, PAY_PER_REQUEST デフォルト値はPROVISIONEDです。 |
| ReadCapacityUnits | String | False | Defines the maximum number of strongly consistent read operations per second, applicable only when 'BillingMode' is set to 'PROVISIONED'.
デフォルト値は5です。 |
| WriteCapacityUnits | String | False | Defines the maximum number of write operations per second, applicable only when 'BillingMode' is set to 'PROVISIONED'.
デフォルト値は5です。 |
| Name | Type | Description |
| Success | String | Indicates the outcome of the operation. Returns 'True' if the table was created successfully, otherwise 'False'. |
| プロパティ | 説明 |
| UseLakeFormation | このプロパティがtrue に設定される場合、AWSLakeFormation サービスは、設定されたIAM ロールに基づくユーザーに対してアクセスポリシーを適用する一時的な資格情報を取得するために使用されます。このサービスは、SAML アサーションを提供した上で、OKTA、ADFS、AzureAD、PingFederate 経由で認証する場合に使用できます。 |
| プロパティ | 説明 |
| AuthScheme | Amazon DynamoDB に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。 |
| Domain | AWS のドメイン名を指定します。組織がAWS にドメイン名を関連付けている場合、このプロパティを使用してカスタムドメイン名を設定します。 |
| DynamoDBVPCEndpoint | Specifies the Amazon DynamoDB VPC endpoint to use when connecting through AWS PrivateLink. |
| AWSAccessKey | AWS アカウントのアクセスキーを指定します。この値には、AWS セキュリティ認証情報ページからアクセスできます。 |
| AWSSecretKey | AWS アカウントのシークレットキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。 |
| AWSRoleARN | 認証時に使用するロールのAmazon リソースネーム。 |
| AWSRegion | Amazon Web サービスのホスティングリージョン。 |
| AWSCredentialsFile | 認証に使用するAWS クレデンシャルファイルへのパス。 |
| AWSCredentialsFileProfile | 提供されたAWSCredentialsFile から使用されるプロファイルの名前。 |
| AWSSessionToken | AWS のセッショントークン。 |
| AWSExternalId | 他のアカウントでロールを引き受ける際に必要となる一意の識別子。 |
| MFASerialNumber | MFA デバイスが使用されている場合は、そのシリアル番号。 |
| MFAToken | MFA デバイスから利用できる一時トークン。 |
| TemporaryTokenDuration | 一時トークンが持続する時間(秒単位)。 |
| AWSCognitoRegion | AWS Cognito のホスティングリージョン。 |
| AWSUserPoolId | ユーザープールのID。 |
| AWSUserPoolClientAppId | ユーザープールのアプリクライアントID。 |
| AWSUserPoolClientAppSecret | ユーザープールのアプリクライアントシークレット。(オプション) |
| AWSIdentityPoolId | ID プールのID。 |
| AWSWebIdentityToken | ID プロバイダーが提供するOAuth 2.0 アクセストークンまたはOpenID Connect ID トークン。 |
| プロパティ | 説明 |
| User | SSO 経由でIDP の認証に使用するIDP ユーザー。 |
| Password | SSO 経由でIDP ユーザーの認証に使用するパスワード。 |
| SSOLoginURL | ID プロバイダーのログインURL。 |
| SSOProperties | セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。 |
| SSOExchangeURL | SAML 応答を処理してサービスの資格情報と交換するために使用するURL。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
| プロパティ | 説明 |
| AutoDetectIndex | Specifies whether the provider should automatically detect and use secondary indexes based on the query criteria. |
| AWSCertificate | The absolute path to the certificate file or the certificate content in PEM format encoded in base64. |
| AWSCertificatePassword | The password for the certificate if applicable, otherwise leave blank. |
| AWSCertificateType | The type of AWSCertificate . |
| AWSPrivateKey | The absolute path to the private key file or the private key content in PEM format encoded in base64. |
| AWSPrivateKeyPassword | The password for the private key if it is encrypted, otherwise leave blank. |
| AWSPrivateKeyType | The type of AWSPrivateKey . |
| AWSProfileARN | Profile to pull policies from. |
| AWSSessionDuration | Duration, in seconds, for the resulting session. |
| AWSTrustAnchorARN | Trust anchor to use for authentication. |
| FlattenArrays | このプロパティは、ネスト配列の要素を個々のカラムにフラット化します。デフォルトでは、ネスト配列はJSON 文字列として返されます。このプロパティを、ネスト配列から抽出する要素の数に設定します。 |
| FlattenObjects | ネストされたオブジェクトプロパティを個々のカラムにフラット化するかどうかを指定します。 |
| FlexibleSchema | Specifies whether the provider should dynamically scan query result sets for additional metadata. Set to true to enable scanning or false to use a static metadata structure. |
| GenerateSchemaFiles | スキーマを生成して保存するユーザーの好みのタイミングを示します。 |
| IgnoreTypes | 無視され、文字列として報告されるデータ型を指定します。 |
| MaximumRequestRetries | 一時的な問題が検出された場合にprovider がリクエストを再試行する最大回数を指定します。一時的な問題には、ネットワークの中断、一過性のエラー、運用上のしきい値を超えることなどを含みます。 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Other | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| Pagesize | Specifies the maximum number of items provider evaluates per API request. The default value, -1, allows the server to calculate the page size automatically. |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| QueryMode | Specifies the mode used by the provider to retrieve results from Amazon DynamoDB. |
| RetryWaitTime | リクエストを再試行する前にprovider が待機する最小時間(ミリ秒数)を指定します。再試行するたびに待機時間は2倍になります。 |
| RowScanDepth | テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。 |
| SeparatorCharacter | DynamoDB のMaps 属性やList 属性など、フラット化された構造の階層を示すために使用する記号を指定します。 |
| ThreadCount | データ選択時の並列スキャンに割り当てるスレッド数を指定します。値が1であれば並列スキャンは無効になり、値が大きければ並列性が高まります。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| TypeDetectionScheme | カラムのデータ型を決定するために使用される方法を指定します。 |
| UseBatchWriteItemOperation | Specifies the use of the BatchWriteItem operation for updates and inserts. This is required for handling binary or binary-set data, as the default operations (ExecuteStatement/BatchExecuteStatement) do not support these field types. |
| UseConsistentReads | Specifies whether consistent reads should always be used when querying DynamoDB. Consistent reads provide the most up-to-date data, but consume more read capacity. |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを指定します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。
| プロパティ | 説明 |
| UseLakeFormation | このプロパティがtrue に設定される場合、AWSLakeFormation サービスは、設定されたIAM ロールに基づくユーザーに対してアクセスポリシーを適用する一時的な資格情報を取得するために使用されます。このサービスは、SAML アサーションを提供した上で、OKTA、ADFS、AzureAD、PingFederate 経由で認証する場合に使用できます。 |
このプロパティがtrue に設定される場合、AWSLakeFormation サービスは、設定されたIAM ロールに基づくユーザーに対してアクセスポリシーを適用する一時的な資格情報を取得するために使用されます。このサービスは、SAML アサーションを提供した上で、OKTA、ADFS、AzureAD、PingFederate 経由で認証する場合に使用できます。
このプロパティがtrue に設定される場合、AWSLakeFormation サービスは、設定されたIAM ロールに基づくユーザーに対してアクセスポリシーを適用する一時的な資格情報を取得するために使用されます。このサービスは、SAML アサーションを提供した上で、OKTA、ADFS、AzureAD、PingFederate 経由で認証する場合に使用できます。
このセクションでは、本プロバイダーの接続文字列で設定可能なAWS Authentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | Amazon DynamoDB に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。 |
| Domain | AWS のドメイン名を指定します。組織がAWS にドメイン名を関連付けている場合、このプロパティを使用してカスタムドメイン名を設定します。 |
| DynamoDBVPCEndpoint | Specifies the Amazon DynamoDB VPC endpoint to use when connecting through AWS PrivateLink. |
| AWSAccessKey | AWS アカウントのアクセスキーを指定します。この値には、AWS セキュリティ認証情報ページからアクセスできます。 |
| AWSSecretKey | AWS アカウントのシークレットキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。 |
| AWSRoleARN | 認証時に使用するロールのAmazon リソースネーム。 |
| AWSRegion | Amazon Web サービスのホスティングリージョン。 |
| AWSCredentialsFile | 認証に使用するAWS クレデンシャルファイルへのパス。 |
| AWSCredentialsFileProfile | 提供されたAWSCredentialsFile から使用されるプロファイルの名前。 |
| AWSSessionToken | AWS のセッショントークン。 |
| AWSExternalId | 他のアカウントでロールを引き受ける際に必要となる一意の識別子。 |
| MFASerialNumber | MFA デバイスが使用されている場合は、そのシリアル番号。 |
| MFAToken | MFA デバイスから利用できる一時トークン。 |
| TemporaryTokenDuration | 一時トークンが持続する時間(秒単位)。 |
| AWSCognitoRegion | AWS Cognito のホスティングリージョン。 |
| AWSUserPoolId | ユーザープールのID。 |
| AWSUserPoolClientAppId | ユーザープールのアプリクライアントID。 |
| AWSUserPoolClientAppSecret | ユーザープールのアプリクライアントシークレット。(オプション) |
| AWSIdentityPoolId | ID プールのID。 |
| AWSWebIdentityToken | ID プロバイダーが提供するOAuth 2.0 アクセストークンまたはOpenID Connect ID トークン。 |
Amazon DynamoDB に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。
AWS のドメイン名を指定します。組織がAWS にドメイン名を関連付けている場合、このプロパティを使用してカスタムドメイン名を設定します。
このプロパティは、サービスに接続する際に使用するAWS のドメイン名を指定します。組織がカスタムAWS ドメインを使用している場合は、ここで入力してください。 固有のドメインを持っていない場合は、デフォルト値の"amazonaws.com" を使用します。接続エラーを回避するため、ドメイン名がAWS の設定と一致していることを確認してください。
Specifies the Amazon DynamoDB VPC endpoint to use when connecting through AWS PrivateLink.
Use this property to connect to DynamoDB through a private VPC endpoint instead of the public service endpoint (the default DynamoDB URL). When set, this property overrides the default regional endpoint (dynamodb.{region}.amazonaws.com).
An AWS PrivateLink endpoint for DynamoDB follows the format: vpce-abcdef12-3455.dynamodb.{region}.vpce.amazonaws.com.
AWS アカウントのアクセスキーを指定します。この値には、AWS セキュリティ認証情報ページからアクセスできます。
AWS アカウントのアクセスキーを見つけるには、次の手順に従います。
AWS アカウントのシークレットキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。
AWS アカウントのシークレットキー。この値には、[AWS セキュリティ認証情報]ページからアクセスできます。
認証時に使用するロールのAmazon リソースネーム。
AWS の外部で認証する場合は、AWS アカウント認証情報ではなく、ロールを認証に使用するのが 一般的です。AWSRoleARN を入力すると、CData Sync App はAWSAccessKey とAWSSecretKey を直接 使用する代わりに、ロールベースの認証を実行します。この認証を実行するためには、AWSAccessKey と AWSSecretKey を指定する必要があります。RoleARN を設定するときは、AWS ルートユーザーの 認証情報を使用できません。AWSAccessKey およびAWSSecretKey はIAM ユーザーのものである必要があります。
Amazon Web サービスのホスティングリージョン。
Amazon Web サービスのホスティングリージョン。利用可能な値は、OHIO、NORTHERNVIRGINIA、NORTHERNCALIFORNIA、OREGON、CAPETOWN、HONGKONG、TAIPEI、HYDERABAD、JAKARTA、MALAYSIA、MELBOURNE、MUMBAI、OSAKA、SEOUL、SINGAPORE、SYDNEY、THAILAND、TOKYO、CENTRAL、CALGARY、BEIJING、NINGXIA、FRANKFURT、IRELAND、LONDON、MILAN、PARIS、SPAIN、STOCKHOLM、ZURICH、TELAVIV、MEXICOCENTRAL、BAHRAIN、UAE、SAOPAULO、GOVCLOUDEAST、GOVCLOUDWEST、ISOLATEDUSEAST、ISOLATEDUSEASTB、ISOLATEDUSEASTF、ISOLATEDUSSOUTHF、ISOLATEDUSWEST、およびISOLATEDEUWEST です。
認証に使用するAWS クレデンシャルファイルへのパス。
認証に使用するAWS クレデンシャルファイルへのパス。詳しくは、https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html を参照してください。
提供されたAWSCredentialsFile から使用されるプロファイルの名前。
提供されたAWSCredentialsFile から使用されるプロファイルの名前。詳しくは、https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html を参照してください。
他のアカウントでロールを引き受ける際に必要となる一意の識別子。
他のアカウントでロールを引き受ける際に必要となる一意の識別子。
MFA デバイスが使用されている場合は、そのシリアル番号。
AWS マネジメントコンソールにアクセスしてユーザーのセキュリティ認証情報を表示することで、IAM ユーザーのデバイスを見つけることができます。 仮想デバイスの場合、これは実際にはAmazon リソースネームです( arn:aws:iam::123456789012:mfa/user など)。
MFA デバイスから利用できる一時トークン。
MFA が必要な場合、この値はログインのためのテンポラリクレデンシャルを取得するためにMFASerialNumber とともに使用されます。 AWS から入手可能な一時的な認証情報はデフォルトで最長1時間しか持続しません(TemporaryTokenDuration を参照してください)。時間が経過したら、新しい認証情報を取得できるように、接続を 更新して新しいMFA トークンを指定する必要があります。
一時トークンが持続する時間(秒単位)。
一時トークンは、MFA 認証とロールベース認証の両方で使用されます。一時トークンは、やがてタイムアウトします。 そのときには、新しい一時トークンを取得する必要があります。MFA が使用されていない状況では、これは大したこと ではありません。一時トークンが期限切れになると、CData Sync App は内部的に新しい一時トークンをリクエストします。
ただし、MFA が必要な接続の場合は、新しい一時トークンを取得するために新しいMFAToken を接続で指定 する必要があります。これは、ユーザーによる接続の更新が必要になるため、より煩わしい問題です。指定できる 最大値と最小値は、使用されている接続によって大きく異なります。
ロールベース認証の場合は、最小期間は900秒(15分)で、最大期間は3600秒(1時間)です。 ロールベース認証でMFA が使用されている場合でも、3600秒が依然として最大です。
MFA 認証自体では(IAM ユーザーまたはルートユーザーを使用)、最小値は900秒(15分)、 最大値は129600(36時間)です。
AWS Cognito のホスティングリージョン。
AWS Cognito のホスティングリージョン。利用可能な値は、OHIO、NORTHERNVIRGINIA、NORTHERNCALIFORNIA、OREGON、CAPETOWN、HONGKONG、TAIPEI、HYDERABAD、JAKARTA、MALAYSIA、MELBOURNE、MUMBAI、OSAKA、SEOUL、SINGAPORE、SYDNEY、THAILAND、TOKYO、CENTRAL、CALGARY、BEIJING、NINGXIA、FRANKFURT、IRELAND、LONDON、MILAN、PARIS、SPAIN、STOCKHOLM、ZURICH、TELAVIV、MEXICOCENTRAL、BAHRAIN、UAE、SAOPAULO、GOVCLOUDEAST、GOVCLOUDWEST、ISOLATEDUSEAST、ISOLATEDUSEASTB、ISOLATEDUSEASTF、ISOLATEDUSSOUTHF、ISOLATEDUSWEST、およびISOLATEDEUWEST です。
ユーザープールのID。
[AWS Cognito]->[Manage User Pools(ユーザープールの管理)]->[select your user pool(ユーザープールを選択)]->[General settings(全般設定)]->[Pool ID(プールのID)]で確認できます。
ユーザープールのアプリクライアントID。
[AWS Cognito]->[Manage Identity Pools(ID プールの管理)]->[select your user pool(ユーザープールを選択)]->[General settings(全般設定)]->[App clients(アプリクライアント)]->[App client ID(アプリクライアントID)]で確認できます。
ユーザープールのアプリクライアントシークレット。(オプション)
[AWS Cognito]->[Manage Identity Pools(ID プールの管理)]->[select your user pool(ユーザープールを選択)]->[General settings(全般設定)]->[App clients(アプリクライアント)]->[App client secret(アプリクライアントシークレット)]で確認できます。
ID プールのID。
[AWS Cognito]->[Manage Identity Pools(ID プールの管理)]->[select your identity pool(ID プールを選択)]->[Edit identity pool(ID プールの編集)]->[Identity Pool(ID プール)]で確認できます。
ID プロバイダーが提供するOAuth 2.0 アクセストークンまたはOpenID Connect ID トークン。
ID プロバイダーが提供するOAuth 2.0 アクセストークンまたはOpenID Connect ID トークン。 アプリケーションは、Web ID プロバイダーでユーザーを認証することで、このトークンを取得できます。 指定しない場合、この接続プロパティの値は、 環境変数'AWS_WEB_IDENTITY_TOKEN_FILE' の値から自動的に取得されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSO プロパティの全リストを提供します。
| プロパティ | 説明 |
| User | SSO 経由でIDP の認証に使用するIDP ユーザー。 |
| Password | SSO 経由でIDP ユーザーの認証に使用するパスワード。 |
| SSOLoginURL | ID プロバイダーのログインURL。 |
| SSOProperties | セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。 |
| SSOExchangeURL | SAML 応答を処理してサービスの資格情報と交換するために使用するURL。 |
SSO 経由でIDP の認証に使用するIDP ユーザー。
このフィールドは、Password とともに、SSO 接続でAmazon DynamoDB サーバーに対して認証をするために使われます。
ID プロバイダーのログインURL。
ID プロバイダーのログインURL。
セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。
セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。SSOProperties はAWSRoleARN およびAWSPrincipalARN と一緒に使用します。次のセクションでは、OKTA ID プロバイダーの利用サンプルを示します。
ADFS に接続するには以下のプロパティを設定します。
接続文字列の例:
AuthScheme=ADFS; AWSRegion=Ireland; [email protected]; Password=CH8WerW121235647iCa6; SSOLoginURL='https://adfs.domain.com'; AWSRoleArn=arn:aws:iam::1234:role/ADFS_SSO; AWSPrincipalArn=arn:aws:iam::1234:saml-provider/ADFSProvider; S3StagingDirectory=s3://athena/staging;
ADFS 統合フローでは、現在Windows にログインしているユーザーの資格情報を使用して接続します。 ADFS 統合フローを使用するには、User およびPassword を指定せず、それ以外の設定は上記のADFS に記載された手順に従ってください。
Okta に接続するには以下のプロパティを設定します。
Okta クライアントリクエストコンテキストをオーバーライドする信頼されたアプリケーションまたはプロキシのいずれかを使用する場合、またはMFA を設定している場合は、Okta を使用して認証するためにSSOProperties を組み合わせて使用する必要があります。必要に応じて、以下のいずれかを設定します。
接続文字列の例:
AuthScheme=Okta; AWSRegion=Ireland; [email protected]; Password=CH8WerW121235647iCa6; SSOLoginURL='https://cdata-us.okta.com/home/amazon_aws/0oa35m8arsAL5f5NrE6NdA356/272'; SSOProperties='ApiToken=01230GGG2ceAnm_tPAf4MhiMELXZ0L0N1pAYrO1VR-hGQSf;'; AWSRoleArn=arn:aws:iam::1234:role/Okta_SSO; AWSPrincipalARN=arn:aws:iam::1234:saml-provider/OktaProvider; S3StagingDirectory=s3://athena/staging;
SAML 応答を処理してサービスの資格情報と交換するために使用するURL。
CData Sync App はここで指定されたURL を使用してSAML 応答を処理し、サービスの資格情報と交換します。 取得した資格情報はSSO 接続時の最後の情報であり、Amazon DynamoDB との通信に使用されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
| 説明 | 例 |
| フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| 証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
| 公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| MD5 Thumbprint(hex 値はスペースまたはコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
| SHA1 Thumbprint(hex 値はスペースまたはコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
| プロパティ | 説明 |
| FirewallType | provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。 |
| FirewallServer | ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。 |
| FirewallPort | プロキシベースのファイアウォールで使用するTCP ポートを指定します。 |
| FirewallUser | プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。 |
| FirewallPassword | プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。 |
provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
Note:デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。
次の表は、サポートされている各プロトコルのポート番号情報です。
| プロトコル | デフォルトポート | 説明 |
| TUNNEL | 80 | Sync App がAmazon DynamoDB への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。 |
| SOCKS4 | 1080 | Sync App がAmazon DynamoDB への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。 |
| SOCKS5 | 1080 | Sync App がAmazon DynamoDB にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで使用するTCP ポートを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。
プロキシベースのファイアウォール(またはプロキシファイアウォール)は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。
プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
| プロパティ | 説明 |
| ProxyAutoDetect | provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。 |
| ProxyServer | HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。 |
| ProxyPort | クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。 |
| ProxyAuthScheme | ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。 |
| ProxyUser | ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。 |
| ProxyPassword | ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。 |
| ProxySSLType | ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。 |
| ProxyExceptions | ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。 |
provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします(プロキシサーバーの詳細を手動で入力する必要はありません)。
この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を構成する場合は、ProxyAutoDetect をFalse に設定します。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレスを指定します。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。
ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。
クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバーのTCP ポートを指定します。
ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。
ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。
その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
サポートされる認証の種類:
NONE 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名を提供します。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyUser に設定する値 |
| BASIC | プロキシサーバーに登録されているユーザーのユーザー名。 |
| DIGEST | プロキシサーバーに登録されているユーザーのユーザー名。 |
| NEGOTIATE | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NTLM | プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。user@domain またはdomain\user の形式で指定。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
Note:Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。
ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。
ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。
ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。
| ProxyAuthScheme の値 | ProxyPassword に設定する値 |
| BASIC | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| DIGEST | ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。 |
| NEGOTIATE | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NTLM | ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。 |
| NONE | ProxyPassword 接続プロパティは設定しないでください。 |
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
Note:Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。 ProxyAutoDetect がTrue(デフォルト)に設定されている場合、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。
ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプを指定します。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。
| AUTO | デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。 |
| ALWAYS | 接続は、常にSSL 有効となります。 |
| NEVER | 接続は、SSL 有効になりません。 |
| TUNNEL | 接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリストを指定します。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Note:Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。 この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| LogModules | ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。 |
ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。
Sync App は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。
ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の Sync App の操作がどのモジュールに属するかを示すラベルとして使用されます。
この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META;
デフォルトでは、すべてのモジュールの操作がログに含まれます。
モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP
サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、Sync App は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res
Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。
使用可能なモジュールとサブモジュールは次のとおりです。
| モジュール名 | モジュールの説明 | サブモジュール |
| INFO | 一般情報。接続文字列、製品バージョン(ビルド番号)、および初期接続メッセージが含まれます。 |
|
| EXEC | クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。 |
|
| HTTP | HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス(POST メッセージを含む)、および Kerberos 関連のメッセージが含まれます。 |
|
| WSDL | WSDL/XSD ファイルの生成に関するメッセージ。 | — |
| SSL | SSL 証明書メッセージ。 |
|
| AUTH | 認証関連の失敗/成功メッセージ。 |
|
| SQL | SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。 |
|
| META | メタデータキャッシュとスキーマメッセージ。 |
|
| FUNC | SQL 関数の実行に関連する情報。 |
|
| TCP | TCP トランスポートレイヤーメッセージでの送受信生バイト。 |
|
| FTP | File Transfer Protocol に関するメッセージ。 |
|
| SFTP | Secure File Transfer Protocol に関するメッセージ。 |
|
| POP | Post Office Protocol 経由で転送されるデータに関するメッセージ。 |
|
| SMTP | Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。 |
|
| CORE | 他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。 | — |
| DEMN | SQL リモーティングに関連するメッセージ。 | — |
| CLJB | 一括データアップロード(クラウドジョブ)に関するメッセージ。 |
|
| SRCE | 他のモジュールに属さない、製品が生成するその他のメッセージ。 | — |
| TRANCE | 低レベルの製品操作に関する高度なメッセージ。 | — |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Tables | レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。 |
| Views | レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は%APPDATA%\\CData\\AmazonDynamoDB Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます:
| プラットフォーム | %APPDATA% |
| Windows | APPDATA 環境変数の値 |
| Linux | ~/.config |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。
レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。
データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。 接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
Note:複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| AutoDetectIndex | Specifies whether the provider should automatically detect and use secondary indexes based on the query criteria. |
| AWSCertificate | The absolute path to the certificate file or the certificate content in PEM format encoded in base64. |
| AWSCertificatePassword | The password for the certificate if applicable, otherwise leave blank. |
| AWSCertificateType | The type of AWSCertificate . |
| AWSPrivateKey | The absolute path to the private key file or the private key content in PEM format encoded in base64. |
| AWSPrivateKeyPassword | The password for the private key if it is encrypted, otherwise leave blank. |
| AWSPrivateKeyType | The type of AWSPrivateKey . |
| AWSProfileARN | Profile to pull policies from. |
| AWSSessionDuration | Duration, in seconds, for the resulting session. |
| AWSTrustAnchorARN | Trust anchor to use for authentication. |
| FlattenArrays | このプロパティは、ネスト配列の要素を個々のカラムにフラット化します。デフォルトでは、ネスト配列はJSON 文字列として返されます。このプロパティを、ネスト配列から抽出する要素の数に設定します。 |
| FlattenObjects | ネストされたオブジェクトプロパティを個々のカラムにフラット化するかどうかを指定します。 |
| FlexibleSchema | Specifies whether the provider should dynamically scan query result sets for additional metadata. Set to true to enable scanning or false to use a static metadata structure. |
| GenerateSchemaFiles | スキーマを生成して保存するユーザーの好みのタイミングを示します。 |
| IgnoreTypes | 無視され、文字列として報告されるデータ型を指定します。 |
| MaximumRequestRetries | 一時的な問題が検出された場合にprovider がリクエストを再試行する最大回数を指定します。一時的な問題には、ネットワークの中断、一過性のエラー、運用上のしきい値を超えることなどを含みます。 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| Other | 特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。 |
| Pagesize | Specifies the maximum number of items provider evaluates per API request. The default value, -1, allows the server to calculate the page size automatically. |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| QueryMode | Specifies the mode used by the provider to retrieve results from Amazon DynamoDB. |
| RetryWaitTime | リクエストを再試行する前にprovider が待機する最小時間(ミリ秒数)を指定します。再試行するたびに待機時間は2倍になります。 |
| RowScanDepth | テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。 |
| SeparatorCharacter | DynamoDB のMaps 属性やList 属性など、フラット化された構造の階層を示すために使用する記号を指定します。 |
| ThreadCount | データ選択時の並列スキャンに割り当てるスレッド数を指定します。値が1であれば並列スキャンは無効になり、値が大きければ並列性が高まります。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
| TypeDetectionScheme | カラムのデータ型を決定するために使用される方法を指定します。 |
| UseBatchWriteItemOperation | Specifies the use of the BatchWriteItem operation for updates and inserts. This is required for handling binary or binary-set data, as the default operations (ExecuteStatement/BatchExecuteStatement) do not support these field types. |
| UseConsistentReads | Specifies whether consistent reads should always be used when querying DynamoDB. Consistent reads provide the most up-to-date data, but consume more read capacity. |
| UserDefinedViews | カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。 |
| UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを指定します。 |
Specifies whether the provider should automatically detect and use secondary indexes based on the query criteria.
This property controls the automatic detection of secondary indexes, which can optimize data selection in DynamoDB tables. By default, this property is set to true, enabling the provider to analyze the query criteria and choose an appropriate secondary index automatically.
This property is useful for scenarios where the default behavior does not align with your query optimization strategy, giving you flexibility to fine-tune index usage for your DynamoDB tables.
The absolute path to the certificate file or the certificate content in PEM format encoded in base64.
The absolute path to the certificate file or the certificate file content in PEM format encoded in base64, depending on the value of AWSCertificateType.
The password for the certificate if applicable, otherwise leave blank.
The password for the certificate if applicable, otherwise leave blank.
The type of AWSCertificate .
This property can take one of the following values:
| PEM_FILE | Absolute path to a certificate file in PEM format. |
| PEM_BLOB | A string (base64-encoded) representing a PEM-encoded certificate. |
The absolute path to the private key file or the private key content in PEM format encoded in base64.
The absolute path to the private key file or the private key file content in PEM format encoded in base64, depending on the value of AWSPrivateKeyType.
The password for the private key if it is encrypted, otherwise leave blank.
The password for the private key if it is encrypted, otherwise leave blank.
The type of AWSPrivateKey .
This property can take one of the following values:
| PEM_FILE | Absolute path to a private key file in PEM format. |
| PEM_BLOB | A string (base64-encoded) representing a PEM-encoded private key. |
Profile to pull policies from.
Profile to pull policies from.
Duration, in seconds, for the resulting session.
Duration, in seconds, for the resulting session. Default: 3600 seconds.
Trust anchor to use for authentication.
Trust anchor to use for authentication.
このプロパティは、ネスト配列の要素を個々のカラムにフラット化します。デフォルトでは、ネスト配列はJSON 文字列として返されます。このプロパティを、ネスト配列から抽出する要素の数に設定します。
このプロパティを使用して、ネスト配列から要素を抽出し、個々のカラムとして表します。
このプロパティは、表形式出力での短い配列の表現を簡素化するのに役立ちます。
抽出された要素には、ゼロベースのインデックスが付加されたカラム名が割り当てられます。配列の残りの要素は無視されます。
例えば、FlattenArrays が2に設定されている場合、以下の配列は2つのカラムにフラット化されます。
["FLOW-MATIC", "LISP", "COBOL"]
| カラム名 | カラム値 |
| languages_0 | FLOW-MATIC |
| languages_1 | LISP |
より長い配列をフラット化すると未使用の要素が破棄される可能性があるため、少数の項目を含むと予想される配列に使用することをお勧めします。
ネストされたオブジェクトプロパティを個々のカラムにフラット化するかどうかを指定します。
このプロパティがtrue に設定されている場合、オブジェクトプロパティは個別のカラムとして抽出されます。false に設定されている場合、配列内のネストされたオブジェクトはJSON 形式の文字列として表されます。 ネストされたオブジェクトを個々のカラムにフラット化することで、構造化データの扱いが簡単になります。有効にすると、プロバイダーはプロパティ名を親オブジェクト名に付加してカラム名を生成します。 これは、予測可能で管理しやすいオブジェクト構造を表形式化するのに役立ちます。
深くネストされた、または大きなJSON オブジェクトの場合、フラット化のパフォーマンスへの影響を考慮してください。過剰なフラット化は、管理しきれない数のカラムを作成する可能性があります。 予測不可能なプロパティやさまざまなスキーマを持つオブジェクトでは、このプロパティを無効にしておくと、より柔軟な表現が可能になります。
例えば、次のネストされたオブジェクトを接続時にフラット化できます。
[
{ "grade": "A", "score": 2 },
{ "grade": "A", "score": 6 },
{ "grade": "A", "score": 10 },
{ "grade": "A", "score": 9 },
{ "grade": "B", "score": 14 }
]
FlattenObjects がtrue に設定されていて、FlattenArrays が1に設定されている場合、配列は次のテーブルのようにフラット化されます。
| カラム名 | カラム値 |
| grades_0_grade | A |
| grades_0_score | 2 |
Specifies whether the provider should dynamically scan query result sets for additional metadata. Set to true to enable scanning or false to use a static metadata structure.
When enabled, this property allows the provider to dynamically analyze query result sets for additional metadata, ensuring the result schema reflects any changes or variations in the queried data. This property is useful when working with data sources where schema details may vary or are not fully known in advance.
Disabling this property preserves a static metadata structure, which may improve performance when querying data with a consistent schema. Use this property based on the predictability of your data source and performance considerations.
スキーマを生成して保存するユーザーの好みのタイミングを示します。
このプロパティは、Location で指定されたパスの.rsd ファイルにスキーマをアウトプットします。
有効な設定は次のとおりです。
GenerateSchemaFiles をOnUse に設定すると、Sync App はSELECT クエリを実行したときにスキーマを生成します。スキーマはクエリのそれぞれの参照されたテーブルに対して生成されます。
GenerateSchemaFiles をOnCreate に設定すると、CREATE TABLE クエリが実行されたときにのみスキーマが生成されます。
このプロパティのもう一つの使い方は、接続するときにデータベース内のすべてのテーブルのスキーマを取得することです。これには、GenerateSchemaFiles をOnStart に設定して接続します。
無視され、文字列として報告されるデータ型を指定します。
このプロパティを使用すると、特定のデータ型を本来の型として処理しないようにすることができます。 型が無視された場合は、文字列として扱われます。デフォルトではDatetime、Date、Time は無視され、本来の型ではなく文字列値として返されます。
このプロパティは、互換性の問題や下流の処理要件により、特定の型をテキストとして扱う必要がある場合に役立ちます。 例えば、Time データ型を扱わないアプリケーションでは、それらを文字列に変換することが有効な場合があります。 Note: このプロパティの変更は、次回接続時に有効になります。
一時的な問題が検出された場合にprovider がリクエストを再試行する最大回数を指定します。一時的な問題には、ネットワークの中断、一過性のエラー、運用上のしきい値を超えることなどを含みます。
このプロパティは、ネットワークの不安定性やレート制限などの一時的な問題が発生した場合に、ドライバーが再試行を試みる回数を制御します。 各再試行において、Sync App は指数バックオフ戦略に従います。再試行間の待機時間はRetryWaitTime で指定された値から始まり、後続の再試行ごとに倍増していき、最大再試行回数に達するまで続きます。
例えば、RetryWaitTime が2秒に設定され、MaximumRequestRetries が5に設定されている場合、Sync App は次のように待機します:0秒(最初の試行)、2秒、4秒、8秒、16秒、32秒。
このプロパティは、高遅延ネットワークやAPI クォータが厳しい環境など、一時的な問題が予想されるシナリオで役立ちます。
集計やGROUP BY を含まないクエリで返される最大行数を指定します。
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)
MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。
特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
Note:特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。
| プロパティ | 説明 |
| DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
| ConvertDateTimeToGMT=True | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換します。デフォルト値はFalse(ローカルタイムを使用)です。 |
| RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
Specifies the maximum number of items provider evaluates per API request. The default value, -1, allows the server to calculate the page size automatically.
Note that this limit applies to the number of items evaluated, not the number of matching items returned. If the dataset size exceeds 1 MB or the number of evaluated items reaches the specified page size, the operation stops and returns the matching results along with a pagination token to retrieve the remaining data. Set this property to a specific value to control the size of each API request and optimize performance. Adjust this property based on your application’s performance and memory requirements.
テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。
Table1=Column1;Table1=Column2;Table2=Column3
すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:
*=*
Specifies the mode used by the provider to retrieve results from Amazon DynamoDB.
This property determines the query execution strategy for retrieving results from DynamoDB:
Use Adaptive for optimal performance, as it dynamically selects the most efficient query mode. Choose PartiQL for precise query translation or SCAN when a complete table scan is required.
リクエストを再試行する前にprovider が待機する最小時間(ミリ秒数)を指定します。再試行するたびに待機時間は2倍になります。
このプロパティは、ネットワーク障害やレート制限のような一時的な問題が検出された場合に再試行するまでの基準待機時間をミリ秒単位で定義します。 再試行するたびに、指数バックオフ戦略に従って待機時間は2倍になります。
再試行の総回数はMaximumRequestRetries プロパティで制御されます。 例えば、RetryWaitTime が2000ミリ秒に設定され、MaximumRequestRetries が3に設定されている場合、ドライバーは後続の再試行前に2000、4000、8000ミリ秒待機します。
テーブルで利用可能なカラムを探すためにスキャンする行数の最大値。
テーブルのカラムはテーブル行をスキャンすることで決定される必要があります。この値はスキャンされる行数の最大値を設定します。
大きい値を設定すると、パフォーマンスが低下する場合があります。小さい値を設定すると、特にnull データがある場合には、データ型を正しく判定できない場合があります。
DynamoDB のMaps 属性やList 属性など、フラット化された構造の階層を示すために使用する記号を指定します。
このプロパティは、DynamoDB 内でフラット化された構造の階層関係を表すために使用される区切り文字を定義します。 例えば、SeparatorCharacter が"." に設定されている場合、address.city という属性は、address がcity という子属性を持つ親属性であることを示します。
指定された区切り文字、例えばピリオド(.)を含む属性名がデータに含まれている場合、カラム名の曖昧さを防ぐために別のSeparatorCharacter を選択する必要があります。 このプロパティは、階層の明確な区分が必要な複雑でネストされたデータ構造を扱う際に役立ちます。
データ選択時の並列スキャンに割り当てるスレッド数を指定します。値が1であれば並列スキャンは無効になり、値が大きければ並列性が高まります。
並列スキャンにより、複数のスレッドで取得プロセスを実行できるため、Amazon DynamoDB で大規模なデータセットをスキャンする際のパフォーマンスが向上します。 ThreadCount で指定されたスレッド数によって、データをどのように分割して処理するかが決まります。ThreadCount を増やすとスキャンが大幅に高速化しますが、テーブルの読み取りユニットの消費も加速します。
ThreadCount の値が大きいほど、CPU コアや帯域幅などより多くのシステムリソースが必要になります。 過度の並列処理はリードキャパシティユニットを迅速に消費し、追加のコストが発生したり、テーブル上の他の操作に影響を与えたりする可能性があります。 このプロパティを調整する前に、システムの利用可能なリソースとDynamoDB テーブルに割り当てられた読み取りユニットを評価することが重要です。
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。
タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。
Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
カラムのデータ型を決定するために使用される方法を指定します。
このプロパティは、カラムのデータ型を決定するための方法を定義します。
デフォルトでは、値が明示的に指定されない場合はRowScanDepth が使用されます。データ型推論が不要な場合や一貫した文字列型付けが望ましい場合は、None を使用してください。
Specifies the use of the BatchWriteItem operation for updates and inserts. This is required for handling binary or binary-set data, as the default operations (ExecuteStatement/BatchExecuteStatement) do not support these field types.
By default, the Sync App uses the ExecuteStatement or BatchExecuteStatement operation to handle updates and inserts. However, these operations do not support manipulating binary or binary-set fields. To handle these data types, enable this property to switch to the BatchWriteItem operation.
Using BatchWriteItem may alter the behavior and performance characteristics of updates and inserts. This property should only be enabled when your dataset includes binary or binary-set data that needs to be inserted or updated. For other use cases, the default operations are sufficient.
Specifies whether consistent reads should always be used when querying DynamoDB. Consistent reads provide the most up-to-date data, but consume more read capacity.
When this property is set to true, the Sync App performs consistent reads, ensuring the most up-to-date data is returned for queries and scans. However, consistent reads consume twice as many read capacity units as eventually consistent reads. Use this property only when accurate and immediate data consistency is critical for your use case.
Note: Consistent reads are not supported for global secondary indexes. If you scan or query using a secondary index, the property is ignored even if set to true.
カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。
UserDefinedViews を使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。 これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。
次に例を示します。
{
"MyView": {
"query": "SELECT * FROM Account WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。
次に例を示します。
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonUserDefinedViews でビューを指定すると、Sync App はそのビューだけを参照します。
詳しくは、ユーザー定義ビュー を参照してください。
テーブルとカラムに簡略名を使用するかどうかを指定します。
Amazon DynamoDB テーブルでは、標準的なデータベースでは通常許可されない特殊文字を名前に含めることができます。このプロパティを使用すると、Sync App を従来のデータベースツールでより簡単に使用できるようになります。
UseSimpleNames をTrue に設定すると、返されるカラム名をシンプルにします。 表示されるカラム名において、アルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。
Notes:
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.