Amazon DynamoDB への接続を追加

1. アプリケーションコンソールで、接続ページに移動します。
2. 接続の追加パネルで、追加したい接続のアイコンを選択します。
3. Amazon DynamoDB アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからAmazon DynamoDB コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

DynamoDB への接続

以下を設定してデータに接続します。

• Domain：AWS に関連付けられたドメイン名を使用する場合に設定。
• AWSRegion：Amazon DynamoDB データがホストされているリージョンに設定。

DynamoDB への認証

AWS キーを取得

1. IAM コンソールにサインインします。
2. ナビゲーションペインでユーザーを選択します。
3. ユーザーのアクセスキーを作成または管理するには、ユーザーを選択してからセキュリティ認証情報タブを選択します。

1. ルートアカウントの認証情報を使用してAWS 管理コンソールにサインインします。
2. アカウント名または番号を選択します。
3. 表示されたメニューでMy Security Credentials を選択します。
4. ルートアカウントのアクセスキーを管理または作成するには、Continue to Security Credentials をクリックし、［Access Keys］セクションを展開します。

ルートクレデンシャル

アカウントのルートクレデンシャルで認証するには、次の設定パラメータを設定します。

• AuthScheme：AwsRootKeys。
• AWSAccessKey：AWS ルートアカウントに紐づいているアクセスキー。
• AWSSecretKey：AWS ルートアカウントに紐づいているシークレットキー。

Note： この認証スキームの使用は、簡単なテスト以外ではAmazon では推奨されていません。アカウントのルート認証情報はユーザーの完全な権限を持つため、これが最も安全性の低い認証方法になります。

多要素認証が必要な場合は、以下を指定します。

• CredentialsLocation：MFA クレデンシャルが保存される設定ファイルの場所。詳しくは、接続文字列オプションのCredentials File Location のページを参照してください。
• MFASerialNumber：MFA デバイスが使用されている場合は、そのシリアル番号。
• MFAToken：MFA デバイスから利用できる一時トークン。

Note： 一時的な認証情報の有効期間（デフォルトは3600秒）を制御するには、TemporaryTokenDuration プロパティを設定します。

一時クレデンシャル

一時クレデンシャルで認証するには、次を設定します。

• AuthScheme：TemporaryCredentials。
• AWSAccessKey：ロールを担うIAM ユーザーのアクセスキー。
• AWSSecretKey：ロールを担うIAM ユーザーのシークレットキー。
• AWSSessionToken：一時クレデンシャルと共に提供されるAWS のセッショントークン。 詳細はAWS Identity and Access Management ユーザーガイド を参照してください。

Sync App は、一時クレデンシャルの有効期間中、長期的な認証情報（IAM ユーザー認証情報など）によって提供されるものと同じ権限を使用してリソースをリクエストできるようになりました。

一時クレデンシャルおよびIAM ロールの両方を使用して認証するには、上記のすべてのパラメータを設定し、さらに以下のパラメータを指定します。

• AWSRoleARN：認証したいロールのRole ARN を指定。これにより、Sync App は指定されたロールの認証情報を取得しようと試みます。
• AWSExternalId（オプション）：別のAWS アカウントでロールを引き受ける場合にのみ必要です。

多要素認証が必要な場合は、以下を指定します。

• CredentialsLocation：MFA クレデンシャルが保存される設定ファイルの場所。詳しくは、接続文字列オプションのCredentials File Location のページを参照してください。
• MFASerialNumber：MFA デバイスが使用されている場合は、そのシリアル番号。
• MFAToken：MFA デバイスから利用できる一時トークン。

Note： 一時的な認証情報の有効期間（デフォルトは3600秒）を制御するには、TemporaryTokenDuration プロパティを設定します。

EC2 Instances

AuthScheme をAwsEC2Roles に設定します。

EC2 インスタンスからSync App を使用していて、そのインスタンスにIAM ロールが割り当てられている場合は、 認証にIAM ロールを使用できます。Sync App は自動的にIAM ロールの認証情報を取得し、それらを使って認証するため、AWSAccessKey およびAWSSecretKey を指定する必要はありません。

認証にIAM ロールも使用している場合は、さらに以下を指定する必要があります。

• AWSRoleARN：認証したいロールのRole ARN を指定。これにより、Sync App は指定されたロールの認証情報を 取得しようと試みます。
• AWSExternalId（オプション）：別のAWS アカウントでロールを引き受ける場合にのみ必要です。

IMDSv2 サポート

Amazon DynamoDB Sync App は、IMDSv2 をサポートしています。IMDSv1 とは異なり、新バージョンでは認証トークンが必須です。エンドポイントおよびレスポンスは、両バージョンで同じです。

IMDSv2 では、Amazon DynamoDB Sync App はまずIMDSv2 メタデータトークンの取得を試み、それを使用してAWS メタデータエンドポイントを呼び出します。トークンを取得できない場合、Sync App はIMDSv1 を使用します。

AWS Web Identity

AuthScheme をAwsWebIdentity に設定します。

Web ID でロールを割り当てられるように構成されたコンテナ（OpenID Provider を持つEKS クラスタ内のPod など）からSync App を使用する場合、またはIAM ロールに関連付けられたWeb ID プロバイダーで認証してID トークンを取得する場合は、Web ID トークンとIAM ロールの情報を一時的なセキュリティ認証情報と交換し、AWS サービスを認証してアクセスすることができます。コンテナの環境変数にAWS_ROLE_ARN とAWS_WEB_IDENTITY_TOKEN_FILE が指定されている場合、Sync App は自動的に認証情報を取得します。または、AWSRoleARN とAWSWebIdentityToken の両方を指定し、AssumeRoleWithWebIdentity API 操作を実行して認証することもできます。

AWS IAM Roles

AuthScheme をAwsIAMRoles に設定します。

多くの場合、認証にはAWS ルートユーザーのダイレクトなセキュリティ認証情報ではなく、IAM ロールを使用することをお勧めします。AWS ルートユーザーのAWSAccessKey およびAWSSecretKey を指定している場合、ロールは使用できない場合があります。

AWS ロールとして認証するには、次のプロパティを設定します。

• AWSAccessKey：ロールを担うIAM ユーザーのアクセスキー。
• AWSSecretKey：ロールを担うIAM ユーザーのシークレットキー。
• AWSRoleARN：認証したいロールのRole ARN を指定。これにより、Sync App は指定されたロールの認証情報を 取得しようと試みます。
• AWSExternalId（オプション）：別のAWS アカウントでロールを引き受ける場合にのみ必要です。

多要素認証が必要な場合は、以下を指定します。

• CredentialsLocation：MFA クレデンシャルが保存される設定ファイルの場所。詳しくは、接続文字列オプションのCredentials File Location のページを参照してください。
• MFASerialNumber：MFA デバイスが使用されている場合は、そのシリアル番号。
• MFAToken：MFA デバイスから利用できる一時トークン。

Note： 一時的な認証情報の有効期間（デフォルトは3600秒）を制御するには、TemporaryTokenDuration プロパティを設定します。

ADFS

ADFS に接続するには、AuthScheme をADFS に設定し、次のプロパティを設定します。

• User：ADFS ユーザー。
• Password：ADFS ユーザーのパスワード。
• SSOLoginURL：SSO プロバイダーのログインURL。

接続文字列の例：

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 統合

ADFS 統合フローでは、現在ログインしているWindows ユーザーの資格情報で接続します。 ADFS 統合フローを使用するには、User およびPassword を指定せず、それ以外の設定は上記のADFS ガイドと同じ手順を実行してください。

Okta

Okta に接続するには、AuthScheme をOkta に設定し、次のプロパティを設定します。

• User：Okta ユーザー。
• Password：Okta ユーザーのパスワード。
• SSOLoginURL：SSO プロバイダーのログインURL。

Okta クライアントリクエストコンテキストをオーバーライドする信頼されたアプリケーションまたはプロキシを使用する場合、またはMFA を設定している場合は、Okta を使用して認証するためにSSOProperties を組み合わせて使用する必要があります。必要に応じて、以下のいずれかを設定します。

• APIToken：Okta クライアントリクエストコンテキストをオーバーライドする、信頼されたアプリケーションまたはプロキシ経由でユーザーを認証する場合、これを顧客がOkta 組織で作成したAPI Token に設定します。
• MFAType：MFA フローを設定した場合、次の対応するタイプのいずれかに設定します：OktaVerify、Email、またはSMS。
• MFAPassCode：MFA フローを設定した場合は、有効なパスコードに設定します。
  これを空欄または無効な値に設定した場合、Sync App はユーザーのデバイスまたはE メールにワンタイムパスワードチャレンジを発行します。パスコードを受信後、取得したワンタイムパスワードをMFAPassCode 接続プロパティに設定する接続を再度開きます。
• MFARememberDevice：デフォルトはTrue です。Okta は、MFA が必要な場合にデバイスを記憶させることをサポートします。設定された認証ポリシーに従ってデバイスの記憶が許可されている場合、Sync App はMFA 認証の有効期間を延長するデバイストークンを送信します。MFA を記憶させない場合は、この 変数をFalse に設定してください。

接続文字列の例：

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;

PingFederate に接続するには、AuthScheme をPingFederate に設定し、次のプロパティを設定します。

• User：PingFederate ユーザー。
• Password：PingFederate ユーザーのパスワード。
• SSOLoginURL：SSO プロバイダーのログインURL。
• AWSRoleARN（オプション）：複数のロールARN がある場合は、認可に使用するARN を指定します。
• AWSPrincipalARN（オプション）：複数のプリンシパルARN がある場合は、認可に使用するARN を指定します。
• SSOExchangeUrl：SP Connections -> SP Connection -> WS-Trust -> Protocol Settings の下にあるPingFederate サーバーインスタンスで設定されるPartner Service Identifier URI。これはPingFederate SP Connection を一意に識別する必要があるため、AWS SSO ACS URL に設定することを推奨します。Authentication フィールドの横にあるAWS SSO -> Settings -> View Details の下で確認できます。
• SSOProperties（オプション）：Amazon S3へのリクエストにユーザー名とパスワードを認可ヘッダーとして含める場合は、Authscheme=Basic。

SSOLoginURL 用の相互SSL 認証（WS-Trust STS エンドポイント）を有効化するには、次の SSOProperties を設定します。

• SSLClientCert
• SSLClientCertType
• SSLClientCertSubject
• SSLClientCertPassword

接続文字列の例：

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 に関連するすべての設定が使用できます。 これを行うには、次のプロパティを設定して認証します。

• AuthScheme：AwsCredentialsFile。
• AWSCredentialsFile：クレデンシャルファイルの場所。
• AWSCredentialsFileProfile（オプション）：指定したクレデンシャルファイルから使用するプロファイルの名前。指定しない場合は、default という名前のプロファイルが使用されます。

AWS Cognito クレデンシャル

AWS Cognito のユーザープールに登録されたユーザーでSync App を使用する場合は、以下のプロパティを設定して認証してください。

• AuthScheme：AwsCognitoSrp に設定（推奨）。また、AwsCognitoBasic を使用することもできます。
• AWSCognitoRegion：ユーザープールのリージョンに設定。
• AWSUserPoolId：ユーザープールのId に設定。
• AWSUserPoolClientAppId：ユーザープールのアプリクライアントId に設定。
• AWSUserPoolClientAppSecret：ユーザープールのクライアントシークレットに設定。
• AWSIdentityPoolId：ユーザープールとリンクしているID プールのId に設定。
• User：ユーザープールに登録されているユーザーのユーザー名に設定。
• Password：ユーザープールに登録されているユーザーのパスワードに設定。

データ型の推測

次のプロパティを使って、自動データ型検出を設定できます。デフォルトは有効です。

• TypeDetectionScheme：このプロパティを使って、RowScanDepth で指定された値に基づく自動型検出を有効化/無効化できます。
• RowScanDepth：このプロパティは、カラムのデータ型を判定するためにスキャンされる行数を指定します。
• IgnoreTypes：無視してvarchar データ型として解決すべきデータ型。デフォルトではDate、Time、およびDatetime 型が無視されます。これは、Amazon DynamoDB がそれらを型としてサポートしていないためです。 これらのカラムのフィルタリングは、元のvarchar データ型としてのみ実行できます。

データアクセスのファインチューニング

次のプロパティを使って、Amazon DynamoDB API 機能およびSync App のストラテジーをさらに制御できます。

• UseSimpleNames：Amazon DynamoDB は、多くのデータベース指向のツールがサポートしていない特殊文字を使った属性名をサポートしています。

  加えて、Amazon DynamoDB のテーブル名にはドットおよびダッシュを含めることができます。Sync App はテーブル名内のドットを階層区切りとして解釈し、XPath と同じようにネストされたフィールドをドリルダウンできます。

  このプロパティを使用すると、英数字以外の文字をアンダースコアで置き換えられます。

• SeparatorCharacter：このプロパティを使用すると、ドキュメントとリストのクエリ ときにネストされたフィールドにより簡単にアクセスできます。このプロパティで階層区切りを指定します。デフォルトでは、これは '.'（ドット）文字です。

リトライインターバルの設定

次のプロパティを設定すると、"maximum throughput exceeded" などの一時的なエラーを返す代わりに、クエリを再試行できます。

• RetryWaitTime：リクエストを再試行するためにSync App が待機する最小時間（ミリ秒数）。
• MaximumRequestRetries：リクエストをリトライする最大回数。

また、CData Sync App には、クエリに応じて使い分けることができるPartiQL とScan という2つの独立したAPI があります。使用されるAPI は、実行されるクエリによって異なります。

PartiQL

効果的なページングの使用

Pagesize プロパティを使うと、アイテムのサイズおよびAmazon DynamoDB の1MB のページサイズを基に、プロビジョニングされたスループットの使用を最適化できます。このプロパティを、返すアイテム数に設定します。

一般的に、ページサイズが小さくなると、スロットルの原因となるスループットのスパイクが低減します。また、リクエスト間にポーズも挿入されます。この間隔はリクエストのディストリビューションを均等化し、スロットルを回避することでより多くのリクエストを成功するようにします。

Scans

ThreadCount 接続プロパティを設定することで、Scan リクエスト実行時に使用するスレッド数を変更できます。使用するスレッド数が増えると、より多くのメモリが使用されますが、各スレッドの結果はより速くなります。 デフォルトは4です。この機能は、高スループットまたは変動するスループットがプロビジョニング済みのテーブルに最適です。

単一のスレッドでテーブルの最大スループットを超えてしまうようなケースでは、シングルスレッドのPartiQL API よりもScan を使うメリットはありません。 Amazon DynamoDB は、最大スループットを超えなくなるまで、すべてのスレッドを単純に制御します。

カスタムIAM ポリシーを作成するよりも、定義済みのロールをサービスに使用することを推奨します。Amazon DynamoDB の事前定義されたロールは次のとおりです。

• AmazonDynamoDBReadOnlyAccess- AWS Management Console からDynamoDB リソースへの読み取り専用アクセスを許可します。
• AmazonDynamoDBFullAccess- AWS Management Console からDynamoDB リソースへのフルアクセスを許可します。

          "Resource": [
              "arn:aws:dynamodb:us-east-1:987654321098:table/Customers",
              "arn:aws:dynamodb:us-east-1:987654321098:table/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"
          ]
      }

"Resource": "arn:aws:dynamodb:us-east-1:987654321098:table/*"

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
}

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

カラム名の区切り文字をドットから変更するには、SeparatorCharacter を設定します。

配列のフラット化

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

"coord": [ -73.856077, 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"
}

SELECT * FROM [restaurants.grades]

grades 配列は、さらにいくつか深いレベルでネストできます。 その場合、同じ構文を使用する必要があります。

SELECT * FROM [restaurants.cuisine.bakery.grades]

{
  "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"
}

SELECT * FROM [restaurants.reviews.\[0\].grades]

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 }
]

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 }

Amazon DynamoDB はNoSQL データソースであり、クエリも標準的なリレーショナルデータベースとは異なるハンドリングが必要です。

Value-Sensitive クエリ

カラムにデータ型の指定がないということは、一つのカラムに異なるデータ型を格納することができるということです。例として、ある行には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'

カラムデータ型の検出

データ型検出だけでは値が明確ではない場合には、Sync App は自動検出されたカラムと比較します。Location テーブルにCoordinates というカラムを挿入したい場合には、INSERT は次のようになります：

INSERT INTO Locations (Address, Coordinates) VALUES ('123 Fake Street', '[40.7127, 74.0059]')

Coordinates カラムがLocations テーブルをスキャンした際に自動検出されていなかった場合には、挿入された値のデータ型が使われます。

この場合にもINSERT がNumberSet であることを解決することができますが、いくらか難解な作業が必要です。

Count

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 MyTable

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

SELECT [MyList.0], [MyList.1.Email], [MyList.1.Age] FROM MyTable

ドキュメントおよびリストの挿入

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}]')

ドキュメントおよびリストの更新

更新(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'

データ型のマッピング

Sync App は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。さらに、IgnoreTypes 接続プロパティに基づいて返される利用可能なデータのスキャンを試みます。 以下のテーブルはこれらのマッピングを説明します。

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="&amp;quot;restaurant_id&amp;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="&amp;quot;borough&amp;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="&amp;quot;address&amp;quot;.&amp;quot;zipcode&amp;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="&amp;quot;address&amp;quot;.&amp;quot;coord&amp;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="&amp;quot;address&amp;quot;.&amp;quot;coord&amp;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="&amp;quot;address&amp;quot;.&amp;quot;building&amp;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="&amp;quot;address&amp;quot;.&amp;quot;street&amp;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="&amp;quot;name&amp;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="&amp;quot;cuisine&amp;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="&amp;quot;restaurant_id&amp;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="&amp;quot;borough&amp;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="&amp;quot;address&amp;quot;.&amp;quot;zipcode&amp;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="&amp;quot;address&amp;quot;.&amp;quot;coord&amp;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="&amp;quot;address&amp;quot;.&amp;quot;coord&amp;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="&amp;quot;address&amp;quot;.&amp;quot;building&amp;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="&amp;quot;address&amp;quot;.&amp;quot;street&amp;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="&amp;quot;name&amp;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="&amp;quot;cuisine&amp;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 の高度な機能を厳選して説明します。

Automatic Index Detection

ユーザー定義ビュー

Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

詳しくは、クエリ処理 を参照してください。

ログ

SSL 設定のカスタマイズ

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

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

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

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

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

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 は二種類のプライマリキーをサポートします。

• Hash キー：これは単一列のキーです。
• Hash + Range キー：これは2列のキーで、ハッシュ列と範囲列を含みます。

Amazon DynamoDB テーブルはスキーマレスであり、Sync App では以下の二つの方法でスキーマをアンカバーします。

動的スキーマ

テーブルのカラムは最初の数行をスキャンすることで動的に決定されます。RowScanDepth プロパティを変更することで、スキャンする行数を調節することができます。カラム名のほかに、行スキャンがデータ型を決定します。次のテーブルは、どのようにAmazon DynamoDB でサポートされている異なるデータ型がSync App においてモデル化されているかを説明します。

静的スキーマ

動的に組成されるスキーマを使う代わりに、自分でスキーマを定義することも可能です。これにより、射影されるカラムを管理できるほか、boolean、datetime など、別のデータ型を使用することができます。独自のスキーマを作成するには、CreateSchema ストアドプロシージャを参照してください。新しいスキーマファイルのFileName（フルパス）およびTableName を、Amazon DynamoDB テーブルの名前に合致するように指定し、カラムリストを編集し、お客様自身のテーブルとして利用します。

スキーマレス処理

テーブルスキーマはメタデータを報告する際に必要ですが、データの選択、挿入、更新、削除ではスキーマに存在しないカラムからのデータが扱われることがあります。まだスキーマテーブルが存在していないカラムのデータ型は、指定されたデータに基づいて動的に決定されます。詳しくは、DynamoDB クエリ を参照してください。

Connection

AWS Authentication

SSO

SSL

Firewall

Proxy

Logging

Schema

Miscellaneous

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

このプロパティがtrue に設定される場合、AWSLakeFormation サービスは、設定されたIAM ロールに基づくユーザーに対してアクセスポリシーを適用する一時的な資格情報を取得するために使用されます。このサービスは、SAML アサーションを提供した上で、OKTA、ADFS、AzureAD、PingFederate 経由で認証する場合に使用できます。

解説

このプロパティがtrue に設定される場合、AWSLakeFormation サービスは、設定されたIAM ロールに基づくユーザーに対してアクセスポリシーを適用する一時的な資格情報を取得するために使用されます。このサービスは、SAML アサーションを提供した上で、OKTA、ADFS、AzureAD、PingFederate 経由で認証する場合に使用できます。

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

Amazon DynamoDB に接続する際に使用する認証の種類を指定します。このプロパティが空白の場合は、デフォルトの認証が使用されます。

解説

• TemporaryCredentials：一時的なセキュリティ認証情報を、セッショントークンと一緒に利用して認証します。
• AwsRootKeys：クイックテストを実行するために、ルートユーザーのアクセスキーとシークレットを使用して認証します。（本番環境のユースケースでは、権限を絞ったものを使用することをお勧めします。）
• AwsIAMRoles：IAM ロールを使用して認証します。
• AwsEC2Roles：Sync App が現在実行されているEC2 マシンに割り当てられたIAM ロールを自動的に使用します。
• Okta：OKTA をID プロバイダーとしたシングルサインオン接続を使用する場合に設定します。
• ADFS：ADFS をID プロバイダーとしたシングルサインオン接続を使用する場合に設定します。
• PingFederate：PingFederate をID プロバイダーとしたシングルサインオン接続を使用する場合に設定します。
• AwsCredentialsFile：認証にクレデンシャルファイルを使用するために設定します。
• AwsCognitoSrp：Cognito ベースの認証を使用するために設定します。このオプションは、認証のためにパスワードをサーバーに送信せず、代わりにSRP プロトコルを使用します。そのため、AwsCognitoBasic よりもこのオプションを推奨します。
• AwsCognitoBasic：Cognito ベースの認証を使用するために設定します。

AWS のドメイン名を指定します。組織がAWS にドメイン名を関連付けている場合、このプロパティを使用してカスタムドメイン名を設定します。

解説

このプロパティは、サービスに接続する際に使用するAWS のドメイン名を指定します。組織がカスタムAWS ドメインを使用している場合は、ここで入力してください。 固有のドメインを持っていない場合は、デフォルト値の"amazonaws.com" を使用します。接続エラーを回避するため、ドメイン名がAWS の設定と一致していることを確認してください。

AWS アカウントのアクセスキーを指定します。この値には、AWS セキュリティ認証情報ページからアクセスできます。

解説

AWS アカウントのアクセスキーを見つけるには、次の手順に従います。

1. ルートアカウントの認証情報を使用してAWS 管理コンソールにサインインします。
2. アカウント名または番号を選択します。
3. メニューでMy Security Credentials を選択します。
4. Continue to Security Credentials をクリックします。
5. ルートアカウントのアクセスキーを表示または管理するには、Access Keys セクションを展開します。

AWS アカウントのシークレットキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。

解説

AWS アカウントのシークレットキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。

1. ルートアカウントの認証情報を使用してAWS 管理コンソールにサインインします。
2. アカウント名または番号を選択し、表示されたメニューで［My Security Credentials］を選択します。
3. ［Continue to Security Credentials］をクリックし、［Access Keys］セクションを展開して、ルートアカウントのアクセスキーを管理または作成します。

認証時に使用するロールの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、HYDERABAD、JAKARTA、MALAYSIA、MELBOURNE、MUMBAI、OSAKA、SEOUL、SINGAPORE、SYDNEY、TOKYO、CENTRAL、CALGARY、BEIJING、NINGXIA、FRANKFURT、IRELAND、LONDON、MILAN、PARIS、SPAIN、STOCKHOLM、ZURICH、TELAVIV、BAHRAIN、UAE、SAOPAULO、GOVCLOUDEAST、GOVCLOUDWEST、ISOLATEDUSEAST、ISOLATEDUSEASTB、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 を参照してください。

AWS のセッショントークン。

解説

AWS のセッショントークン。この値はさまざまな方法で取得できます。詳しくは、this link を参照してください。

他のアカウントでロールを引き受ける際に必要となる一意の識別子。

解説

他のアカウントでロールを引き受ける際に必要となる一意の識別子。

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、HYDERABAD、JAKARTA、MALAYSIA、MELBOURNE、MUMBAI、OSAKA、SEOUL、SINGAPORE、SYDNEY、TOKYO、CENTRAL、CALGARY、BEIJING、NINGXIA、FRANKFURT、IRELAND、LONDON、MILAN、PARIS、SPAIN、STOCKHOLM、ZURICH、TELAVIV、BAHRAIN、UAE、SAOPAULO、GOVCLOUDEAST、GOVCLOUDWEST、ISOLATEDUSEAST、ISOLATEDUSEASTB、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 プロパティの全リストを提供します。

SSO 経由でIDP の認証に使用するIDP ユーザー。

解説

このフィールドは、Password とともに、SSO 接続でAmazon DynamoDB サーバーに対して認証をするために使われます。

SSO 経由でIDP ユーザーの認証に使用するパスワード。

解説

User およびPassword をSSO 接続で一緒に使用してサーバーで認証を行います。

ID プロバイダーのログインURL。

解説

ID プロバイダーのログインURL。

セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。

解説

セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。SSOProperties はAWSRoleARN およびAWSPrincipalARN と一緒に使用します。次のセクションでは、OKTA ID プロバイダーの利用サンプルを示します。

ADFS

ADFS に接続するには、AuthScheme をADFS に設定し、次のプロパティを設定します。

• User：ADFS ユーザー。
• Password：ADFS ユーザーのパスワード。
• SSOLoginURL：SSO プロバイダーのログインURL。

接続文字列の例：

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 統合

ADFS 統合フローでは、現在ログインしているWindows ユーザーの資格情報で接続します。 ADFS 統合フローを使用するには、User およびPassword を指定せず、それ以外の設定は上記のADFS ガイドと同じ手順を実行してください。

Okta

Okta に接続するには、AuthScheme をOkta に設定し、次のプロパティを設定します。

• User：Okta ユーザー。
• Password：Okta ユーザーのパスワード。
• SSOLoginURL：SSO プロバイダーのログインURL。

Okta クライアントリクエストコンテキストをオーバーライドする信頼されたアプリケーションまたはプロキシを使用する場合、またはMFA を設定している場合は、Okta を使用して認証するためにSSOProperties を組み合わせて使用する必要があります。必要に応じて、以下のいずれかを設定します。

• APIToken：Okta クライアントリクエストコンテキストをオーバーライドする、信頼されたアプリケーションまたはプロキシ経由でユーザーを認証する場合、これを顧客がOkta 組織で作成したAPI Token に設定します。
• MFAType：MFA フローを設定した場合、次の対応するタイプのいずれかに設定します：OktaVerify、Email、またはSMS。
• MFAPassCode：MFA フローを設定した場合は、有効なパスコードに設定します。
  これを空欄または無効な値に設定した場合、Sync App はユーザーのデバイスまたはE メールにワンタイムパスワードチャレンジを発行します。パスコードを受信後、取得したワンタイムパスワードをMFAPassCode 接続プロパティに設定する接続を再度開きます。
• MFARememberDevice：デフォルトはTrue です。Okta は、MFA が必要な場合にデバイスを記憶させることをサポートします。設定された認証ポリシーに従ってデバイスの記憶が許可されている場合、Sync App はMFA 認証の有効期間を延長するデバイストークンを送信します。MFA を記憶させない場合は、この 変数をFalse に設定してください。

接続文字列の例：

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 プロパティの全リストを提供します。

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

解説

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

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

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

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

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

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。 プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

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

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

認証タイプは次のいずれかです。

• BASIC：Sync App はHTTP BASIC 認証を行います。
• DIGEST：Sync App はHTTP DIGEST 認証を行います。
• NTLM：Sync App はNTLM トークンを取得します。
• NEGOTIATE：Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
• NONE：ProxyServer が認証を必要としない場合に設定します。

"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

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

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。 ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。 各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。 複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。 利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログ の「高度なログの記録」セクションを参照してください。

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

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\AmazonDynamoDB Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 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 プロパティの全リストを提供します。

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.

• Disabling Automatic Detection: Set this property to false if automatic index selection is not desired, such as when the query logic does not align with the detected index or when you prefer manual control over index usage.
• Manual Index Selection: Use the SecondaryIndexName pseudo-column in your query to specify the index you want to use, bypassing the automatic detection logic.

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.

このプロパティは、ネスト配列の要素を個々のカラムにフラット化します。デフォルトでは、ネスト配列はJSON 文字列として返されます。このプロパティを、ネスト配列から抽出する要素の数に設定します。

解説

このプロパティを使用して、ネスト配列から要素を抽出し、個々のカラムとして表します。 このプロパティは、表形式出力での短い配列の表現を簡素化するのに役立ちます。 抽出された要素には、ゼロベースのインデックスが付加されたカラム名が割り当てられます。配列の残りの要素は無視されます。 例えば、FlattenArrays が2に設定されている場合、以下の配列は2つのカラムにフラット化されます。

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

より長い配列をフラット化すると未使用の要素が破棄される可能性があるため、少数の項目を含むと予想される配列に使用することをお勧めします。

ネストされたオブジェクトプロパティを個々のカラムにフラット化するかどうかを指定します。

解説

このプロパティが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に設定されている場合、配列は次のテーブルのようにフラット化されます。

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 ファイルにスキーマをアウトプットします。

有効な設定は次のとおりです。

• Never：スキーマファイルは生成されません。
• OnUse：スキーマファイルがまだ存在していない場合に、初めてテーブルが参照されるときにスキーマファイルが生成されます。
• OnStart：現在スキーマファイルを持たないあらゆるテーブルに対して、接続時にスキーマファイルが生成されます。
• OnCreate：CREATE TABLE SQL クエリを実行すると、スキーマファイルが生成されます。

SQL でスキーマを生成する

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 を使用しないクエリで返される最大行数を指定します。

解説

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

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

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

特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

解説

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティをセミコロン区切りのリストで定義できます。

Note： 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット

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:

• Adaptive: Automatically selects the best query mode based on the SQL statement filters and ThreadCount.
• PartiQL: Translates supported SQL statements into their PartiQL equivalents for execution.
• SCAN: Performs a full table scan, using parallel threads as specified by ThreadCount.

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秒です。タイムアウトを無効にするには0を設定します。

解説

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

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

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

カラムのデータ型を決定するために使用される方法を指定します。

解説

このプロパティは、カラムのデータ型を決定するための方法を定義します。

• None： すべてのカラムは文字列型として返されます。Header=True の場合、この設定を行ってもカラム名はスキャンされます。
• RowScan： 行がスキャンされ、その内容に基づいてデータ型がヒューリスティックに推測されます。スキャンの深さはRowScanDepth プロパティで制御されます。

デフォルトでは、値が明示的に指定されない場合は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.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.json。 このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

詳しくは、ユーザー定義ビュー を参照してください。

テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

解説

Amazon DynamoDB テーブルおよびカラムでは、 通常のデータベースでは使うことが認められていない特殊記号・文字を名前に使うことができます。UseSimpleNames を使用すると、Sync App を従来のデータベースツールでより簡単に使用できるようになります。

UseSimpleNames をtrue に設定し、返されるテーブル名およびカラム名をシンプルにします。表示されるテーブル名 およびカラム名においてアルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。 英数字以外の文字はすべて、アンダースコアに変換されます。