Cloud

Build 25.0.9540
  • SurveyMonkey
    • はじめに
      • 接続の確立
      • カスタムOAuth アプリケーションの作成
      • SurveyMonkey のアンケートからの選択
      • SSL の設定
      • ファイアウォールとプロキシ
    • データモデル
      • テーブル
        • CollectorDetails
        • CollectorMessageDetails
        • CollectorRecipientDetails
        • Collectors
        • SurveyDetails
        • Surveys
      • ビュー
        • CollectorMessages
        • CollectorRecipients
        • CollectorStats
        • ContactLists
        • Contacts
        • Pages
        • RollupQuestions
        • Rollups
        • SurveyQuestions
        • SurveyResponses
      • ストアドプロシージャ
        • CreateSurveyQuestion
        • CreateSurveyResponse
        • DeleteSurveyQuestion
        • DeleteSurveyResponse
        • SendMessage
        • UpdateSurveyQuestion
        • UpdateSurveyResponse
      • システムテーブル
        • sys_catalogs
        • sys_schemas
        • sys_tables
        • sys_tablecolumns
        • sys_procedures
        • sys_procedureparameters
        • sys_keycolumns
        • sys_foreignkeys
        • sys_primarykeys
        • sys_indexes
        • sys_connection_props
        • sys_sqlinfo
        • sys_identity
        • sys_information
    • 接続文字列オプション
      • Authentication
        • AuthScheme
        • AccessToken
      • OAuth
        • OAuthClientId
        • OAuthClientSecret
        • OAuthAccessToken
        • Scope
        • Datacenter
      • SSL
        • SSLServerCert
      • Logging
        • Verbosity
      • Schema
        • BrowsableSchemas
      • Miscellaneous
        • MaxRows
        • Pagesize
        • PseudoColumns
        • ReplaceNullValuesForPK
        • ShowCustomVariables
        • ThrowsKeyNotFound
        • Timeout
        • UseSimpleNames
    • Third Party Copyrights

SurveyMonkey - CData Cloud

概要

CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるSurveyMonkey へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してSurveyMonkey に接続できます。

CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、SurveyMonkey への接続を標準化し、構成することができます。

主要機能

  • SQL をフルサポート:SurveyMonkey は、標準のリレーショナルデータベースとして表示され、Filter、Group、Join などの操作を実行できます。これらの操作は基盤となるAPI でサポートされているかどうかに関わらず、標準SQL を使用します。
  • CRUD サポート:読み取りと書き込みの両方の操作がサポートされており、Cloud またはデータソースのダウンストリームで設定できるセキュリティ設定によってのみ制限されます。
  • セキュアアクセス:管理者は、ユーザーを作成し、特定のデータベースへのアクセス、読み取り専用操作、または完全な読み書きの権限を定義することができます。
  • 包括的なデータモデルとダイナミックディスカバリー:CData Cloud は、動的データや検索可能なメタデータへのフルアクセスなど、基盤となるデータソースで公開されるすべてのデータへの包括的なアクセスを提供します。

CData Cloud

はじめに

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

SurveyMonkey への接続

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

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

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

CData Cloud

接続の確立

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

SurveyMonkey への接続

SurveyMonkey は、アンケートデータに接続する2つの方法を提供します。

  • Basic 認証を使用するには、プライベートアプリケーションを登録して個人用アクセストークンを取得します。
  • OAuth で接続するには、SurveyMonkey に付属している埋め込みOAuth 認証情報を使用するか、カスタムOAuth アプリケーションを作成します。 詳しくは、以下のOAuth 認証を参照してください。

SurveyMonkey への認証

Basic 認証

Basic 認証を使用するには、プライベートアプリケーションを登録して個人用アクセストークンを取得する必要があります。

個人用アクセストークンを取得したら、以下のプロパティを設定します。

  • AuthScheme = AccessToken
  • AccessToken = アプリケーション設定で生成されたAccessToken を入力。

OAuth 認証

SurveyMonkey は埋め込みOAuth 認証情報を提供しており、デスクトップアプリケーション からの接続を簡単にします。Web アプリケーションから接続するには、カスタムOAuth アプリケーションの作成 で説明するようにカスタムOAuth アプリケーションを作成する必要があります。

すべての認証フローで、OAuth 経由で接続するにはAuthScheme をOAuth に設定する必要があります。(これは、接続に埋め込みOAuth 認証情報を使用するか、カスタムOAuth アプリケーションを作成するかに関係なく適用されます。)

以下のサブセクションでは、利用可能なOAuth フローでのSurveyMonkey への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成についての情報と、すでに埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成 を参照してください。

SurveyMonkey で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

CData Cloud

カスタムOAuth アプリケーションの作成

Creating a Custom OAuth Application

CData embeds OAuth Application Credentials with CData branding that can be used when connecting to SurveyMonkey via a desktop application or a headless machine.

However, you must create a custom OAuth application to connect to SurveyMonkey via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway.

Custom OAuth applications are useful if you want to:

  • control branding of the authentication dialog;
  • control the redirect URI that the application redirects the user to after the user authenticates; or
  • customize the permissions that you are requesting from the user.

Procedure

The following procedure obtains the OAuth client credentials, the OAuthClientId, OAuthClientSecret and OAuthAccessToken, and registers the application in the SurveyMonkey developer console.

  1. Open the SurveyMonkey developer console at https://developer.surveymonkey.com/.
  2. Click My Apps.
  3. Log in to your SurveyMonkey account.
  4. Click Create an App. Specify an application nickname, and specify whether the application should be private or public. (Public application use requires an Advantage-level plan; private application use requires a Premier-level plan.)
  5. Click Settings. The console displays the application settings for Client Id, Secret, and Access Token.
    • If this is a desktop application, set the Callback URL to http://localhost:33333 or a different port number of your choice.
    • If this is a Web application, set the Callback URL to a web page where the user should be redirected after they authorize your application.
  6. Select the scopes required by your application. The Cloud requires the following scopes:
    • View Users
    • View Surveys
    • View Responses
    • View Response Details
    • View Contacts
    • View Collectors

CData Cloud

SurveyMonkey のアンケートからの選択

The Cloud offers the possibility to select surveys as relational tables.

Creating Surveys

You can create your own Surveys by performing the following steps:

  1. In SurveyMonkey, go to the home page and click "Create Survey" on the vertical navigation bar.
  2. Either start a new survey from scratch or pick one of the many templates SurveyMonkey offers.
  3. Design and create new questions for your survey.
  4. When finished, pick one of the options to share your survey and start receiving data from it.

Selecting Responses from Your Survey

To access the responses to your surveys, append _Responses to your table name, MySurvey_Responses in the query below.

SELECT RespondentId, QuestionText, ChoiceId, ChoiceText, ChoiceWeight FROM MySurvey_Responses

Selecting Questions from Your Survey

To access your survey questions, append _Questions to your table name, MySurvey_Questions in the query below.

SELECT QuestionId, QuestionFamily, QuestionSubtype, QuestionText, AnswerText FROM MySurvey_Questions

CData Cloud

SSL の設定

SSL 設定のカスタマイズ

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

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

CData Cloud

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

Firewall またはProxy 経由の接続

HTTP プロキシ

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

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

その他のプロキシ

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

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

CData Cloud

データモデル

アカウント内の任意のアンケートや関連データにアクセスできます。CData Cloud は、SurveyMonkey API のエンティティをテーブル、ビュー、およびストアドプロシージャにモデル化します。

これらはスキーマファイルにて定義されます。スキーマファイルは、スキーマを簡単に拡張できるシンプルな形式のコンフィギュレーションファイルです。

クエリ処理の使用

Cloud は、SurveyMonkey API にできるだけ多くのSELECT 構文処理をオフロードし、残りのクエリをCloud 内で処理します。このセクションでは、API の制限および要件について説明します。

フィルタリングの制限

ほとんどのビューは、データを取得するために少なくとも1つのフィルタ条件を必要とします。 このようなビューにクエリを実行する場合、OR 演算子は以下の条件下でのみサポートされます。 1.他のAND 演算子とは組み合わせられません。 2.OR 演算子の両側(左側と右側)は同じフィールドを使用し、比較には等号(=)を使用します。 フィルタ条件を必要としないビューの場合、OR 条件はクライアント側で評価されます。

ビュー

Cloud は、アンケートおよび分析をリレーショナルビュー としてモデル化します。ビューは、一般的には読み取り専用のテーブルです。

ストアドプロシージャ

ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。

CData Cloud

テーブル

Cloud はSurveyMonkey のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - SurveyMonkey テーブル

Name Description
CollectorDetails Displays detailed collector information.
CollectorMessageDetails Displays detailed information regarding messages sent from a collector.
CollectorRecipientDetails Displays detailed information regarding recipients of all or specific messages sent from a collector.
Collectors Displays collector information.
SurveyDetails Displays detailed information regarding surveys.
Surveys Displays information regarding surveys.

CData Cloud

CollectorDetails

Displays detailed collector information.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The Id of the collector.

SurveyId String False

The Id of the survey this collector belongs to.

Name String False

The name of the collector.

Status String False

The collector status. Possible values are 'open' or 'closed'.

Type String False

The collector type. Possible values are 'sms', 'weblink', or 'email'.

ThankYouPageIsEnabled Boolean False

Specifies whether to use the custom thank you message.

ThankYouPageMessage String False

The custom message for the thank you page, regardless of whether a custom thank you message is enabled. The default value is 'Thank you for completing our survey!'.

ThankYouMessage String False

The message for thank you page.

DisqualificationMessage String False

The message for disqualification page.

DisqualificationUrl String False

The redirect URL when the respondent is disqualified.

CloseDate Datetime False

The close date of the collector.

ClosedPageMessage String False

The message shown when someone visits a closed survey.

RedirectUrl String False

The redirect URL when a respondent completes the survey.

DisplaySurveyResults Boolean False

Shows respondents survey instant results when they complete the survey.

EditResponseType String False

When respondents can edit their response. 'until_complete', 'never', or 'always'.

AnonymousType String False

Turns off IP tracking. For email collectors, it also removes the respondent email address and name from the response. Possible values are 'not_anonymous', 'partially_anonymous', or 'fully_anonymous'.

AllowMultipleResponses Boolean False

Allows respondents to take a survey more than once from the same browser on the same computer. Only available for weblink collectors.

DateModified Datetime False

The date collector was last modified.

Url String False

If the collector is a Web Collector (type 'weblink'), the URL for the collector.

DateCreated Datetime False

The date the collector was created.

PasswordEnabled Boolean False

Indicates whether the collector is password protected. Only available for weblink collectors.

SenderEmail String False

The sender email for email collectors. The user's email is used if null.

RedirectType String False

Determines the survey end page behavior. Possible values are 'url' (redirects to the URL set in redirect_url or if none is set, shows standard SurveyMonkey thank you page), 'close' (closes the survey window or tab), or 'loop' (loops the survey back to the beginning; only available for weblink collectors with allow_multiple_responses:true).

Href String False

The resource API URL.

Width Int64 False

The width of your popup.

Height Int64 False

The height of your popup.

BorderColor String False

The border color surrounding the survey.

IsBrandingEnabled Boolean False

Indicates whether the popup has SurveyMonkey branding.

Headline String False

The title of the modal window surrounding the survey.

Message String False

The message below the headline.

SampleRate Int64 False

The percentage of people who see your popup.

PrimaryButtonBgColor String False

The primary button’s background color.

PrimaryButtonTextColor String False

The primary button’s text color.

PrimaryButtonText String False

The text on the primary button.

SecondaryButtonBgColor String False

The secondary button’s background color.

SecondaryButtonTextColor String False

The secondary button’s text color.

SecondaryButtonText String False

The text on the secondary button.

RespondentAuthentication Bool False

Indicates whether Respondent Authentication is required. This is used in conjunction with SSO (single sign-on) to require respondents to sign-in. You can use Respondent Authentication to send more secure internal surveys and track the people taking your survey with SSO metadata.

Password String False

Sets a password to restrict access to your survey.

ResponseLimit Int64 False

Sets the collector to close after specified number of responses are collected.

FromCollectorId String False

The collector Id to copy collector from.

CData Cloud

CollectorMessageDetails

Displays detailed information regarding messages sent from a collector.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The Id of the message.

CollectorId [KEY] String False

The Id of the collector the message belongs to.

Status String False

The status of the message.

Type String False

The message type. Possible values are 'invite', 'reminder', or 'thank_you'.

Subject String False

The subject of the message.

Body String False

The HTML body of the message.

DateCreated Datetime False

The date the message was created.

ScheduleDate Datetime False

The date the message is scheduled to be sent. If Null, the message has not been scheduled to send.

IsBrandingEnabled Boolean False

Indicates whether branding is enabled for the message.

IsScheduled Boolean False

Indicates whether the message is scheduled.

RecipientStatus String False

The set of recipients to send to.

CData Cloud

CollectorRecipientDetails

Displays detailed information regarding recipients of all or specific messages sent from a collector.

Table Specific Information

Select

You must specify SurveyId and CollectorId to query from this view. The Cloud will execute other filters client-side in memory.

Survey ID, collector ID, message ID, and ID can be processed server side. The valid combinations are:

  • SurveyId and CollectorId
  • SurveyId, CollectorId, and Id
  • CollectorId and MessageId
Other combinations may produce incorrect results. For example, the following queries are processed server side:
SELECT * FROM CollectorRecipientDetails WHERE SurveyId = '159264810' AND CollectorId = '218025675'

SELECT * FROM CollectorRecipientDetails WHERE SurveyId = '159264810' AND CollectorId = '218025675' AND Id = '4178228027'

SELECT * FROM CollectorRecipientDetails WHERE CollectorId = '218025675' AND MessageId = '3456'

Columns

Name Type ReadOnly Description
Id [KEY] String False

The Id of the recipient.

SurveyId [KEY] String False

The Id of the survey.

CollectorId [KEY] String False

The Id of the collector this recipient belongs to.

MessageId String False

The Id of the message this recipient belongs to.

FirstName String False

The first name of the recipient.

LastName String False

The last name of the recipient.

Email String False

The email of the recipient.

SurveyResponseStatus String False

Indicates whether the recipient has completed the survey. Possible values are 'not_responded', 'partially_responded', or 'completely_responded'.

MailStatus String False

If an invite message to the recipient has been: 'sent', 'not_sent', or is 'processing'.

SurveyLink String False

The link to the survey in the invite.

RemoveLink String False

The unsubscribe link.

ExtraFields String False

Any extra fields.

CustomFields String False

The contact details for the recipient.

PhoneNumber String False

The phone number of the recipient. Required if SMS collector. Should otherwise be excluded.

Duplicates String False

The intended behavior while adding a duplicate recipient. Values include 'add' (default), 'add_if_not_in_message', or 'add_if_not_in_collector'.

ContactId String False

The Id of the contact.

CData Cloud

Collectors

Displays collector information.

Table Specific Information

Select

You must specify the survey Id or the collector Id to query from this view. The Cloud will execute other filters client-side in memory.

The Survey ID and ID can be processed server side. At most, only one of these filters can be used at a time. Specifying both filters in the same query may result in an incorrect result set. For example, the following queries are processed server side:

SELECT * FROM Collectors WHERE SurveyId = '126748712'

SELECT * FROM Collectors WHERE Id = '175305200'

Columns

Name Type ReadOnly Description
Id [KEY] String True

The Id of the collector.

SurveyId String True

The Id of the survey this collector belongs to. Only displays if filtering collectors by SurveyId.

Name String True

The name of the collector.

Status String True

The collector status. Possible values are 'open' or 'closed'. Only available if resource is being queried by Id.

Type String True

The collector type. Possible values are 'weblink' or 'email'. Only available if resource is being queried by Id.

ThankYouMessage String True

The message for the thank you page. Only available if resource is being queried by Id.

DisqualificationMessage String True

The message for the disqualification page. Only available if resource is being queried by Id.

ClosedPageMessage String True

The message shown when someone visits a closed survey. Only available if resource is being queried by Id.

DisplaySurveyResults Boolean True

Shows respondents survey instant results when they complete the survey. Only available if resource is being queried by Id.

EditResponseTypes String True

When respondents can edit their response. Possible values are 'until_complete', 'never', or 'always'. Only available if resource is being queried by Id.

AnonymousType String True

Turns off IP tracking. For email collectors, also removes respondent email address and name from response. Possible values are 'not_anonymous', 'partially_anonymous', or 'fully_anonymous'. Only available if resource is being queried by Id.

SenderEmail String True

The sender email for email collectors. The user's email is used if null. Only available if resource is being queried by Id.

Url String True

If the collector is a Web Collector (type 'weblink'), then the URL for the collector. Only available if resource is being queried by Id.

RedirectType String True

Determines survey end page behavior. Possible values are 'url' (redirects to URL set in redirect_url or if none is set, shows standard SurveyMonkey thank you page), 'close' (closes the survey window or tab), or 'loop' (loops the survey back to the beginning; only available for weblink collectors with 'allow_multiple_responses'='true'). Only available if resource is being queried by Id.

RedirectUrl String True

Redirects respondent to this url upon survey completion. Only available if resource is being queried by Id.

AllowMultipleResponses Boolean True

For weblink collectors, allows respondents to take a survey more than once from the same browser on the same computer. Only available if resource is being queried by Id.

PasswordEnabled Boolean True

For weblink collectors, indicates whether the collector is password protected. Only available if resource is being queried by Id.

DateModified Datetime True

The date the collector was last modified. Only available if resource is being queried by Id.

DateCreated Datetime True

The date the collector was created. Only available if resource is being queried by Id.

CloseDate Datetime True

The close date of the collector. Only available if resource is being queried by Id.

CData Cloud

SurveyDetails

Displays detailed information regarding surveys.

Columns

Name Type ReadOnly Description
Id [KEY] String False

The Id of the survey.

Title String False

The title of the survey.

Nickname String False

The nickname of the survey.

Owner String False

The Id of the survey owner.

Category String False

The category of the survey.

Language String False

The ISO 639-1 code for the survey language.

QuestionCount String False

The number of questions in the survey.

PageCount String False

The number of pages in the survey.

DateCreated Datetime False

The date that the survey was created.

DateModified Datetime False

The date that the survey was modified.

ButtonsTextNextButton String False

Button text.

ButtonsTextPrevButton String False

Button text.

ButtonsTextExitButton String False

Button text.

ButtonsTextDoneButton String False

Button text.

Preview String False

The survey preview URL.

FolderId String False

If applicable, the Id of the folder the survey is in.

EditUrl String False

The survey edit URL.

CollectUrl String False

The survey collect URL.

AnalyzeUrl String False

The survey analyze URL.

SummaryUrl String False

The survey summary URL.

Href String False

The Resource API URL.

ResponseCount String False

The number of responses the survey has received.

Footer Bool False

Indicates whether SurveyMonkey’s footer is displayed.

ThemeId Int64 False

The Id of the theme used to create the survey, if a theme was used.

TemplateId String False

The Id of the template used to create the survey, if a template was used.

CustomVariables String False

The dictionary of survey variables.

Pages String False

An aggregate array containing each quiz page.

FromTeamTemplateId String False

The team survey template to copy from.

FromTemplateId String False

The survey template to copy from (required if 'from_survey_id' is not provided).

FromSurveyId String False

The survey Id to copy from (required if 'from_template_id' is not provided).

QuizOptions String False

An object describing the quiz settings, if this survey is a quiz.

CData Cloud

Surveys

Displays information regarding surveys.

Columns

Name Type ReadOnly Description
Id [KEY] String True

The Id of the survey.

Title String True

The title of the survey.

Nickname String True

The nickname of the survey.

Category String True

The category of the survey.

DateCreated Datetime True

The date that the survey was created.

DateModified Datetime True

The date that the survey was modified.

FolderId String True

If specified, adds the survey to the folder with that Id.

IsOwner Boolean True

Indicates whether the user is the owner of the survey.

Language String True

The language of the survey.

QuestionCount Int True

The number of questions in the survey.

ResponseCount Int True

The number of responses the survey has received.

CData Cloud

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - SurveyMonkey ビュー

Name Description
CollectorMessages Displays information regarding messages sent from a collector.
CollectorRecipients Shows information regarding recipients of all or specific messages sent from a collector.
CollectorStats Shows statistics regarding all or specific messages sent from a collector.
ContactLists Shows contact list information.
Contacts Shows contact information.
Pages Shows information regarding pages for a survey.
RollupQuestions Shows rolled up individual stats information for a survey.
Rollups Shows rolled up stats information for a survey.
SurveyQuestions Shows the available columns for Survey Questions. Append _Questions to your survey name to query survey questions.
SurveyResponses Shows the available columns for Survey Responses. Append _Responses to your survey name to query survey responses.

CData Cloud

CollectorMessages

Displays information regarding messages sent from a collector.

Table Specific Information

Select

You must specify the collector Id to query from this view. The Cloud will execute other filters client-side in memory.

For example, the following queries are processed server side:

SELECT * FROM CollectorMessages WHERE CollectorId = '175305200'

SELECT * FROM CollectorMessages WHERE CollectorId = '175305200' AND Id = '57071816'

Columns

Name Type Description
Id [KEY] String The Id of the message.
CollectorId [KEY] String The Id of the collector the message belongs to.
Status String The status of the message.
Type String The message type. Values include 'invite', 'reminder', or 'thank_you'.
Subject String The subject of the message. Only available if resource is being queried by Id.
Body String The HTML body of the message. Only available if resource is being queried by Id.
DateCreated Datetime The date the message was created. Only available if resource is being queried by Id.
ScheduledDate Datetime The date the message is scheduled to be sent. If Null, the message has not been scheduled to send. Only available if the resource is being queried by Id.
EmbedFirstQuestion Boolean Indicates whether to embed the first question to the message. Only available if resource is being queried by Id.
EditMessageLink String The link to the resource to edit the message. Only available if resource is being queried by Id.
IsBrandingEnabled Boolean Indicates whether branding is enabled for the message. Only available if resource is being queried by Id.
IsScheduled Boolean Indicates whether the message is scheduled. Only available if resource is being queried by Id.
RecipientStatus String The recipient filter. Values include 'reminder' or 'thank_you'. Only available if resource is being queried by Id.

CData Cloud

CollectorRecipients

Shows information regarding recipients of all or specific messages sent from a collector.

Table Specific Information

Select

You must specify the collector Id to query from this view. The Cloud will execute other filters client-side in memory.

The collector ID, message ID, and ID can be processed server side. At most, only two of these filters may be used simultaneously. Specifying all three filters in the same query may result in an incorrect result set. For example, the following queries are processed server side:

SELECT * FROM CollectorRecipients WHERE CollectorId = '175305200'

SELECT * FROM CollectorRecipients WHERE CollectorId = '175305200' AND MessageId = '57071816'

SELECT * FROM CollectorRecipients WHERE CollectorId = '175305200' AND Id = '4496877899'

Columns

Name Type Description
Id [KEY] String The Id of the recipient.
CollectorId String The Id of the collector this recipient belongs to.
MessageId String The Id of the message this recipient belongs to. Null if it doesn't belong to a specific message.
Email String Email of recipient added to collector.
SurveyResponseStatus String If the recipient has completed the survey: 'not_responded', 'partially_responded', 'completely_responded'.
MailStatus String If an invite message to the recipient has been: 'sent', 'not_sent', or is 'processing'.
SurveyLink String Link to the survey in the invite.
RemoveLink String Unsubscribe link.

CData Cloud

CollectorStats

Shows statistics regarding all or specific messages sent from a collector.

Table Specific Information

Select

You must specify the collector Id to query from this view. The Cloud will execute other filters client-side in memory.

For example, the following queries are processed server side:

SELECT * FROM CollectorStats WHERE CollectorId = '175305200'

SELECT * FROM CollectorStats WHERE CollectorId = '175305200' AND MessageId = '57071816'

Columns

Name Type Description
CollectorId String The Id of the collector these statistics belongs to.
MessageId String The Id of the message these statistics belong to. Null if they don't belong to a specific message.
Recipients Integer Count of recipients included in the stats.
CompletelyResponded Integer Count of recipients who have completed a survey response.
NotResponded Integer Count of recipients who have not started the survey.
PartiallyResponded Integer Count of recipients who have begun the survey but not completed it.
Opened Integer Count of recipients that have opened the message.
OptedOut Integer Count of recipients that have clicked on the opt out link.
NotSent Integer Count of recipients that have been added but their message has not been delivered.
Sent Integer Count of recipients that messages have been sent to.
Bounced Integer Count of recipients with messages that bounced.
LinkClicked Integer Count of messages where the included survey link was clicked on.

CData Cloud

ContactLists

Shows contact list information.

Select

The Cloud will execute other filters client-side in memory.

For example, the following queries are processed server side:

SELECT * FROM ContactLists WHERE Id = '123740269'

Columns

Name Type Description
Id [KEY] String The Id of the contact list.
Name String The name of the contact list.

CData Cloud

Contacts

Shows contact information.

Select

The Cloud will execute other filters client-side in memory.

For example, the following queries are processed server side:

SELECT * FROM Contacts WHERE Id = '2842583326'

SELECT * FROM Contacts WHERE ContactListId = '123679423'

Columns

Name Type Description
Id [KEY] String The Id of the contact.
ContactListId String Use this to filter contacts only from the given ContactListId.
FirstName String The first name of the contact.
LastName String The last name of the contact.
Email String The email of the contact.
CustomField1 String The value of the first custom field for this contact.
CustomField2 String The value of the second custom field for this contact.
CustomField3 String The value of the third custom field for this contact.
CustomField4 String The value of the fourth custom field for this contact.
CustomField5 String The value of the fifth custom field for this contact.
CustomField6 String The value of the sixth custom field for this contact.

CData Cloud

Pages

Shows information regarding pages for a survey.

Table Specific Information

Select

You must specify the survey Id for this view to see page information for the survey. The Cloud will execute other filters client-side in memory.

For example, the following query is processed server side:

SELECT * FROM Pages WHERE SurveyId = '1231231'
 
SELECT * FROM Pages WHERE SurveyId = '1231231' AND Id = '1234567'

Columns

Name Type Description
Id [KEY] String The Id of the page.
SurveyId String The Id of the survey.
Title String The title of the page.
Description String The description of the page.
Position Integer The ordinal position of the page.
QuestionCount Integer The number of questions in this page.

CData Cloud

RollupQuestions

Shows rolled up individual stats information for a survey.

Select

You must specify the survey Id for this view to see roll up stats for the survey. The Cloud will execute other filters client-side in memory.

For example, the following query is processed server side:

SELECT * FROM RollupQuestions WHERE SurveyId = '1231231' 

Columns

Name Type Description
SurveyId String The Id of the survey.
QuestionId String The Id of the question
ResponseCount Integer Number of people which answered by selecting this choice.
ResponseTextCount Integer Number of people which answered by writing in a text.
ChoiceId String The Id of the response.
Other Boolean Whether the selected choice was an other response.
Ordinal Int The number of the order this choice appears in the list of choices. Ordinals are used to get a meaningful representation for stats like maximum, minimum, average, median, and standard deviation.
Max Double The maximum value of the ordinals of the answered choices.
Min Double The minimum value of the ordinals of the answered choices.
Mean Double The average value of the ordinals of the answered choices.
Median Double The median value of the ordinals of the answered choices.
Std Double The standard deviation value of the ordinals of the answered choices.

CData Cloud

Rollups

Shows rolled up stats information for a survey.

Table Specific Information

Select

You must specify the survey Id for this view to see roll up stats for the survey. The Cloud will execute other filters client-side in memory. For example, the following query is processed server side:

SELECT * FROM Rollups WHERE SurveyId = '1231231' 

Columns

Name Type Description
SurveyId String The id of the survey.
QuestionId String The id of the question
Family String The family this question belongs to.
Subtype String The subtype this question belongs to.
Answered Integer Number of people who answered this question by picking one of the given choices.
AnsweredOther Integer Number of people who answered this question by picking the other option.
Skipped Integer Number of people who skipped this question.

CData Cloud

SurveyQuestions

Shows the available columns for Survey Questions. Append _Questions to your survey name to query survey questions.

Select

To query the SurveyQuestions view, you must use the name of the survey and append '_Questions' to the end. For some question types when the specific id is not applicable the value will be represented as '0'

SELECT * FROM [Volunteer Feedback Template_Questions]

SELECT * FROM [Benefits Template_Questions]

Columns

Name Type Description
SurveyId String The id of the survey.
QuestionId String The id of the question.
QuestionPosition Integer The position of that query in the Survey.
QuestionText String The text of the question.
QuestionFamily String The family of the question.
QuestionSubtype String The subtype of the question.
ChoiceId String The id of the choice.
ChoiceText String The text of the choice.
ChoiceWeight String The weight of the choice. Used in questions of the subtype rating and ranking. Usually it's an ordinal number in incremenenting order.
ChoiceScore Int This field is dynamic and maps to the corresponding report field.
RowId String The id of the row.
RowText String The text of the row.
ColId String The id of the column.
ColText String The text of the column.
PageId String The id of the page.
PageTitle String The title of the page.

CData Cloud

SurveyResponses

Shows the available columns for Survey Responses. Append _Responses to your survey name to query survey responses.

Select

To query the SurveyResponses view, you must use the name of the survey and append '_Responses' to the end.

The Cloud uses the SurveyMonkey APIs to filter results by the following columns and operators:

  • DateCreated/DateModified and TotalTime: > and <
  • RespondentId: =
  • QuestionId: = and IN
  • ResponseStatus, IpAddress, and TotalTimeUnit: =
The Cloud processes other filters client-side within the Cloud.

For example, the following queries are processed server side:

SELECT * FROM [Volunteer Feedback Template_Responses]

SELECT * FROM [Benefits Template_Responses]

SELECT * FROM [Benefits Template_Responses] WHERE RespondentId = '1234567890'

SELECT * FROM [Benefits Template_Responses] WHERE RespondentId IN ('1234567890', '0987654321')

SELECT * FROM [Benefits Template_Responses] WHERE DateCreated > '2018-01-01' AND DateCreated < '2018-01-30'

SELECT * FROM [Benefits Template_Responses] WHERE QuestionId = '213965574'

SELECT * FROM [Benefits Template_Responses] WHERE QuestionId IN ('213965574', '213963957')

SELECT * FROM [Benefits Template_Responses] WHERE TotalTime > 5 AND TotalTime < 10 AND TotalTimeUnit = 'minute'

SELECT * FROM [Benefits Template_Responses] WHERE IpAddress = '192.168.0.1'

SELECT * FROM [Benefits Template_Responses] WHERE ResponseStatus = 'completed'

Note: When selecting a specific respondent, the aggregate column "Metadata" will be populated with a JsonObject and its elements can be accessed using the JSON_EXTRACT function in the SQLQuery.

Columns

Name Type Description
RespondentId String The id of the respondent, the person who answered this question.
SurveyId String The id of the survey.
RecipientId String The id of the recipient.
PageId String The id of the page.
QuestionId String The id of the question.
QuestionText String The text of the question.
ChoiceId String The id of the choice.
ChoiceText String The text of the choice.
ChoiceWeight String The weight of the choice. Used in questions of the subtype rating and ranking. Usually it's an ordinal number in incremenenting order.
ChoiceScore Int This field is dynamic and maps to the corresponding report field.
IsCorrectChoice Boolean This field is dynamic and maps to the corresponding report field.
RowId String The id of the row.
RowText String The text of the row.
ColId String The id of the column.
ColText String The text of the column.
OtherId String The id of the other field.
OtherText String The text of the other field.
AnswerText String The text of the answer (in the case of an open-ended question).
AnswerTagHexcolors String This field is dynamic and maps to the corresponding report field.
AnswerTagLabels String This field is dynamic and maps to the corresponding report field.
AnswerTagTypes String This field is dynamic and maps to the corresponding report field.
CollectionMode String The mode of collection.
CollectorId String The id of the collector the response was taken for.
TotalTime String Total time spent on this survey.
ResponseStatus String The status of the response. Valid values are `completed`, `partial`, `overquota`, and `disqualified`.
DateCreated Datetime Date and time when survey was created.
DateModified Datetime Date and time when survey was last modified.
CustomValue Integer A custom value for this response.
EditUrl String Survey edit URL.
AnalyzeUrl String Survey analyze URL.
IpAddress String The IP address of the respondent.
QuizCorrectAnswers Int This field is dynamic and maps to the corresponding report field.
QuizIncorrectAnswers Int This field is dynamic and maps to the corresponding report field.
QuizPartiallyCorrectAnswers Int This field is dynamic and maps to the corresponding report field.
QuizTotalScore Int This field is dynamic and maps to the corresponding report field.
QuizTotalQuestions Int This field is dynamic and maps to the corresponding report field.
QuizMaxScore Int This field is dynamic and maps to the corresponding report field.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。

Name Type Description
TotalTimeUnit String The unit of time you want to filter total time values with. Valids units are `second`, `minute`, and `hour`. If not specified, it will use `second` as a default value. This only affects the filtering on SurveyMonkey's end. The values returned for TotalTime from the API will still be in seconds despite what value is being sent for TotalTimeUnit.

CData Cloud

ストアドプロシージャ

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

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

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

Name Description
CreateSurveyQuestion Creates a new question on a survey page.
CreateSurveyResponse Creates a new response on a collector.
DeleteSurveyQuestion Delete a question from a survey page.
DeleteSurveyResponse Delete a response on a collector.
SendMessage Sends or schedules to send an existing message to all message recipients. Targeted message must have a status of 'not_sent'.
UpdateSurveyQuestion Updates a question on a survey page.
UpdateSurveyResponse Update a response on a collector.

CData Cloud

CreateSurveyQuestion

Creates a new question on a survey page.

Input

Name Type Required Description
SurveyId String True The survey ID.
PageId String True The page ID.
Headings String True List of question headings objects.
Position Int32 False Position of question on page.
Family String True Question family determines the type of question.
Subtype String True Question family's subtype further specifies the type of question.
Sorting String False Sorting details of answers.
Required Boolean False Whether an answer is required for this question.
Validation String False Whether the answer must pass certain validation parameters.
ForcedRanking Boolean False Required if type is matrix and subtype is rating or single, whether or not to force ranking.
QuizOptions String False Object containing the quiz properties of this question, if quiz-mode is enabled.
Answers String True Answers object. Required for all question types except open_ended_single.
DisplayOptions String False Display option object. Required for file upload, slider, image choice & emoji/star rating question types.

Result Set Columns

Name Type Description
QuestionId String The ID of the created question if the operation was executed successfully.
Success Boolean Whether the operation was successful or not.

CData Cloud

CreateSurveyResponse

Creates a new response on a collector.

Input

Name Type Required Description
CollectorId String True The colletor ID.
CustomVariables String False Values to any available custom variables in the survey.
CustomValue String False A custom value to attach to the response for a weblink collector.
ResponseStatus String False Status of the response: completed, partial, overquota, disqualified.
IpAddress String False IP Address the response was taken from.
RecipientId Int64 False The recipient ID from an email collector. Required for email collectors.
Pages String True Pages from the survey and their associated responses.

Result Set Columns

Name Type Description
ResponseId String The ID of the created response if the operation was executed successfully.
Success Boolean Whether the operation was successful or not.

CData Cloud

DeleteSurveyQuestion

Delete a question from a survey page.

Input

Name Type Required Description
SurveyId String True The survey ID.
PageId String True The page ID.
QuestionId String True The ID of the question to delete.

Result Set Columns

Name Type Description
Success Boolean Whether the operation was successful or not.

CData Cloud

DeleteSurveyResponse

Delete a response on a collector.

Input

Name Type Required Description
CollectorId String True The colletor ID.
ResponseId String True The ID of the response to delete.

Result Set Columns

Name Type Description
Success Boolean Whether the operation was successful or not.

CData Cloud

SendMessage

Sends or schedules to send an existing message to all message recipients. Targeted message must have a status of 'not_sent'.

Input

Name Type Required Description
CollectorId String True The Id of the collector to which the message belongs.
MessageId String True The Id of the message to be sent.
ScheduledDate Datetime False The date when the message should send. If not specified, message sends immediately. It is advised to include timezone.

Result Set Columns

Name Type Description
Success Boolean Outputs true if the message was sent successfully, false otherwise.

CData Cloud

UpdateSurveyQuestion

Updates a question on a survey page.

Input

Name Type Required Description
SurveyId String True The survey ID.
PageId String True The page ID.
QuestionId String True The ID of the question to update.
Headings String False List of question headings objects.
Position Int32 False Position of question on page.
Family String False Question family determines the type of question.
Subtype String False Question family's subtype further specifies the type of question.
Sorting String False Sorting details of answers.
Required Boolean False Whether an answer is required for this question.
Validation String False Whether the answer must pass certain validation parameters.
ForcedRanking Boolean False Required if type is matrix and subtype is rating or single, whether or not to force ranking.
QuizOptions String False Object containing the quiz properties of this question, if quiz-mode is enabled.
Answers String False Answers object. Required for all question types except open_ended_single.
DisplayOptions String False Display option object. Required for file upload, slider, image choice & emoji/star rating question types.

Result Set Columns

Name Type Description
Success Boolean Whether the operation was successful or not.

CData Cloud

UpdateSurveyResponse

Update a response on a collector.

Input

Name Type Required Description
CollectorId String True The colletor ID.
ResponseId String True The ID of the response to update.
CustomVariables String False Values to any available custom variables in the survey.
CustomValue String False A custom value to attach to the response for a weblink collector.
ResponseStatus String False Status of the response: completed, partial, overquota, disqualified.
IpAddress String False IP Address the response was taken from.
RecipientId Int64 False The recipient ID from an email collector. Required for email collectors.
Pages String False Pages from the survey and their associated responses.

Result Set Columns

Name Type Description
Success Boolean Whether the operation was successful or not.

CData Cloud

システムテーブル

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

スキーマテーブル

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

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

データソーステーブル

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

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

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

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

CData Cloud

sys_catalogs

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

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

SELECT * FROM sys_catalogs

Columns

Name Type Description
CatalogName String データベース名。

CData Cloud

sys_schemas

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

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

          SELECT * FROM sys_schemas
          

Columns

Name Type Description
CatalogName String データベース名。
SchemaName String スキーマ名。

CData Cloud

sys_tables

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

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

          SELECT * FROM sys_tables
          

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベース。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String テーブル名またはビュー名。
TableType String テーブルの種類(テーブルまたはビュー)。
Description String テーブルまたはビューの説明。
IsUpdateable Boolean テーブルが更新可能かどうか。

CData Cloud

sys_tablecolumns

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

次のクエリは、MySurvey_Responses テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='MySurvey_Responses' 

Columns

Name Type Description
CatalogName String テーブルまたはビューを含むデータベースの名前。
SchemaName String テーブルまたはビューを含むスキーマ。
TableName String カラムを含むテーブルまたはビューの名前。
ColumnName String カラム名。
DataTypeName String データ型の名前。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length Int32 カラムのストレージサイズ。
DisplaySize Int32 指定されたカラムの通常の最大幅(文字数)。
NumericPrecision Int32 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。
NumericScale Int32 カラムのスケール(小数点以下の桁数)。
IsNullable Boolean カラムがNull を含められるかどうか。
Description String カラムの簡単な説明。
Ordinal Int32 カラムのシーケンスナンバー。
IsAutoIncrement String カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn String 生成されたカラムであるかどうか。
IsHidden Boolean カラムが非表示かどうか。
IsArray Boolean カラムが配列かどうか。
IsReadOnly Boolean カラムが読み取り専用かどうか。
IsKey Boolean sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType String スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

CData Cloud

sys_procedures

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

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

          SELECT * FROM sys_procedures
          

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベース。
SchemaName String ストアドプロシージャを含むスキーマ。
ProcedureName String ストアドプロシージャの名前。
Description String ストアドプロシージャの説明。
ProcedureType String PROCEDURE やFUNCTION などのプロシージャのタイプ。

CData Cloud

sys_procedureparameters

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

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

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

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'

Columns

Name Type Description
CatalogName String ストアドプロシージャを含むデータベースの名前。
SchemaName String ストアドプロシージャを含むスキーマの名前。
ProcedureName String パラメータを含むストアドプロシージャの名前。
ColumnName String ストアドプロシージャパラメータの名前。
Direction Int32 パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType Int32 データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName String データ型の名前。
NumericPrecision Int32 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。
Length Int32 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale Int32 数値データの小数点以下の桁数。
IsNullable Boolean パラメータがNull を含められるかどうか。
IsRequired Boolean プロシージャの実行にパラメータが必要かどうか。
IsArray Boolean パラメータが配列かどうか。
Description String パラメータの説明。
Ordinal Int32 パラメータのインデックス。
Values String このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams Boolean パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath Boolean パラメータがスキーマ作成操作のターゲットパスかどうか。
Default String 何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName String 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided Boolean プロシージャがネイティブのSurveyMonkey プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns

Name Type Description
IncludeResultColumns Boolean 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

CData Cloud

sys_keycolumns

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

次のクエリは、MySurvey_Responses テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='MySurvey_Responses' 
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
IsKey Boolean カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey Boolean カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。

CData Cloud

sys_foreignkeys

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

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

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

カラム

名前 タイプ 説明
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前
PrimaryKeyName String 主キーの名前。
ForeignKeyName String 外部キーの名前。
ReferencedCatalogName String 主キーを含むデータベース。
ReferencedSchemaName String 主キーを含むスキーマ。
ReferencedTableName String 主キーを含むテーブル。
ReferencedColumnName String 主キーのカラム名。
ForeignKeyType String 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。

CData Cloud

sys_primarykeys

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

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

         SELECT * FROM sys_primarykeys
          

Columns

Name Type Description
CatalogName String キーを含むデータベースの名前。
SchemaName String キーを含むスキーマの名前。
TableName String キーを含むテーブルの名前。
ColumnName String キーカラムの名前。
KeySeq String 主キーのシーケンス番号。
KeyName String 主キーの名前。

CData Cloud

sys_indexes

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

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

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name Type Description
CatalogName String インデックスを含むデータベースの名前。
SchemaName String インデックスを含むスキーマの名前。
TableName String インデックスを含むテーブルの名前。
IndexName String インデックス名。
ColumnName String インデックスに関連付けられたカラムの名前。
IsUnique Boolean インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary Boolean インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type Int16 インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder String 並べ替え順序:A が昇順、D が降順。
OrdinalPosition Int16 インデックスのカラムのシーケンスナンバー。

CData Cloud

sys_connection_props

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

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

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name Type Description
Name String 接続プロパティ名。
ShortDescription String 簡単な説明。
Type String 接続プロパティのデータ型。
Default String 明示的に設定されていない場合のデフォルト値。
Values String 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value String 設定した値またはあらかじめ設定されたデフォルト。
Required Boolean プロパティが接続に必要かどうか。
Category String 接続プロパティのカテゴリ。
IsSessionProperty String プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity String プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName String キャメルケースの短縮形の接続プロパティ名。
Ordinal Int32 パラメータのインデックス。
CatOrdinal Int32 パラメータカテゴリのインデックス。
Hierarchy String このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible Boolean プロパティが接続UI に表示されるかどうかを通知します。
ETC String プロパティに関するその他のさまざまな情報。

CData Cloud

sys_sqlinfo

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

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

データソースのSELECT 機能

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

名前説明有効な値
AGGREGATE_FUNCTIONSサポートされている集計関数。AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNTCOUNT 関数がサポートされているかどうか。YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR識別子をエスケープするための開始文字。[
IDENTIFIER_QUOTE_CLOSE_CHAR識別子をエスケープするための終了文字。]
SUPPORTED_OPERATORSサポートされているSQL 演算子。=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BYGROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIESサポートされている外部結合の種類。NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS外部結合がサポートされているかどうか。YES, NO
SUBQUERIESサブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONSサポートされている文字列関数。LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONSサポートされている数値関数。ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONSサポートされている日付および時刻関数。NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLESレプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNSレプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTIONプロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。YES, NO
DIALECT使用するSQL ダイアレクトを示します。
KEY_PROPERTIESUniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMASプロバイダー用に複数のスキームが存在するかどうかを示します。YES, NO
SUPPORTS_MULTIPLE_CATALOGSプロバイダー用に複数のカタログが存在するかどうかを示します。YES, NO
DATASYNCVERSIONこのドライバーにアクセスするために必要な、CData Sync のバージョン。Standard, Starter, Professional, Enterprise
DATASYNCCATEGORYこのドライバーのCData Sync カテゴリ。Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQLAPI で提供されている以上の、追加SQL 機能がサポートされているかどうか。TRUE, FALSE
SUPPORTS_BATCH_OPERATIONSバッチ操作がサポートされているかどうか。YES, NO
SQL_CAPこのドライバーでサポートされているすべてのSQL 機能。SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERYドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。YES, NO
PSEUDO_COLUMNS利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。TRUE, FALSE
REPLICATION_MIN_DATE_QUERYレプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTIONサーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATEレプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERYレプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTIONサーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTIDCheckCache 構文を親キーカラムに対して実行するかどうかを示します。TRUE, FALSE
CREATE_SCHEMA_PROCEDURESスキーマファイルの生成に使用できる、ストアドプロシージャを示します。

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

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。

Columns

Name Type Description
NAME String SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE String サポートされるSQL またはSQL 構文の詳細。

CData Cloud

sys_identity

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

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

         SELECT * FROM sys_identity
          

Columns

Name Type Description
Id String データ変更処理から返された、データベース生成Id。
Batch String バッチの識別子。1 は単一処理。
Operation String バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。
Message String SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

CData Cloud

sys_information

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

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

SELECT * FROM sys_information

Columns

NameTypeDescription
ProductString製品名。
VersionString製品のバージョン番号。
DatasourceString製品が接続するデータソースの名前。
NodeIdString製品がインストールされているマシンの固有識別子。
HelpURLString製品のヘルプドキュメントのURL。
LicenseString製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。)
LocationString製品のライブラリが格納されているファイルパスの場所。
EnvironmentString製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersionString本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategoryStringCData Sync 機能のカテゴリ(例:Source、Destination)。

CData Cloud

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication


プロパティ説明
AuthSchemeThe type of authentication to use when connecting to SurveyMonkey.
AccessTokenThe Access Token of the SurveyMonkey application.

OAuth


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
OAuthAccessTokenデータソースへのリクエストを認証するために使用されるOAuth アクセストークンを指定します。このトークンは、OAuth 交換が正常に完了した後に認可サーバーから発行されます。
ScopeThe Scope supplied from the app settings.
DatacenterThe originating datacenter of the SurveyMonkey account. It will determine the API access URL to use during authentication and data retrieval.

SSL


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

Logging


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

Schema


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

Miscellaneous


プロパティ説明
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Pagesizeprovider がSurveyMonkey にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ReplaceNullValuesForPKUpdate NULL values to 0 for primary keys
ShowCustomVariablesA boolean determining if custom variables and their values should be listed when querying Survey_Responses.
ThrowsKeyNotFound更新された行がない場合に例外をスローするかどうかを指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseSimpleNamesテーブルとカラムに簡略名を使用するかどうかを指定します。
CData Cloud

Authentication

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


プロパティ説明
AuthSchemeThe type of authentication to use when connecting to SurveyMonkey.
AccessTokenThe Access Token of the SurveyMonkey application.
CData Cloud

AuthScheme

The type of authentication to use when connecting to SurveyMonkey.

Possible Values

OAuth, AccessToken

データ型

string

デフォルト値

"OAuth"

解説

  • OAuth: Set to this to perform OAuth authentication.
  • AccessToken: Set this to perform Access Token authentication. Provide value for [AccessToken] connection property.

CData Cloud

AccessToken

The Access Token of the SurveyMonkey application.

データ型

string

デフォルト値

""

解説

The Access Token of the SurveyMonkey application.

CData Cloud

OAuth

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


プロパティ説明
OAuthClientIdカスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
OAuthClientSecretカスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
OAuthAccessTokenデータソースへのリクエストを認証するために使用されるOAuth アクセストークンを指定します。このトークンは、OAuth 交換が正常に完了した後に認可サーバーから発行されます。
ScopeThe Scope supplied from the app settings.
DatacenterThe originating datacenter of the SurveyMonkey account. It will determine the API access URL to use during authentication and data retrieval.
CData Cloud

OAuthClientId

カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。

データ型

string

デフォルト値

""

解説

このプロパティは2つのケースで必要となります:

  • カスタムOAuth アプリケーションを使用する場合。たとえば、Web ベースの認証フロー、サービスベースの認証、またはアプリケーションの登録が必要な証明書ベースのフローなどが該当します。
  • ドライバーが埋め込みOAuth 資格情報を提供しない場合。

(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)

OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。

クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

OAuthClientSecret

カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)

データ型

string

デフォルト値

""

解説

このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。

クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。

Notes:

  • この値は安全に保管し、公開リポジトリやスクリプト、安全でない環境では決して公開しないようにしてください。
  • クライアントシークレットは、一定期間が経過すると有効期限が切れる場合もあります。 アクセスを中断させないために、有効期限を常に監視し、必要に応じてシークレットをローテーションするようにしてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

OAuthAccessToken

データソースへのリクエストを認証するために使用されるOAuth アクセストークンを指定します。このトークンは、OAuth 交換が正常に完了した後に認可サーバーから発行されます。

データ型

string

デフォルト値

""

解説

OAuthAccessToken は、保護されたリソースへのアクセスを認可する一時的な認証情報です。 これは通常、ユーザーまたはクライアントアプリケーションがOAuth 認証フローを完了した後に、ID プロバイダーから返されます。 このプロパティは、自動化されたワークフローや、トークンの処理をドライバーの外部で管理したいカスタムOAuth 実装で最も一般的に使用されます。

OAuth アクセストークンにはサーバーに依存する時間制限があり、ユーザーのアクセスを制限します。 タイムアウトは、OAuthExpiresIn プロパティを使用して設定します。ただし、ユーザーが操作を続けている限り、リクエスト間で再発行することでアクセスを維持することができます。

InitiateOAuth がREFRESH に設定されている場合、OAuthExpiresIn とOAuthTokenTimestamp の両方を設定することを推奨します。 Cloud は、これらのプロパティを使用してトークンの有効期限を判断し、最も効率的にリフレッシュできるようにします。 OAuthExpiresIn およびOAuthTokenTimestamp が指定されていない場合、Cloud はトークンを直ちにリフレッシュします。

Note:アクセストークンは機密性の高い認証情報として扱い、安全に保管する必要があります。アクセス制御されていないログ、スクリプト、または設定ファイルでの公開は避けてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。

CData Cloud

Scope

The Scope supplied from the app settings.

データ型

string

デフォルト値

""

解説

The Scope supplied from the app settings. Recommended to be specified when using a custom app.

CData Cloud

Datacenter

The originating datacenter of the SurveyMonkey account. It will determine the API access URL to use during authentication and data retrieval.

Possible Values

US, EU, CA

データ型

string

デフォルト値

"US"

解説

  • US: Set this to use https://api.surveymonkey.com
  • EU: Set this to use https://api.eu.surveymonkey.com
  • CA: Set this to use https://api.surveymonkey.ca

CData Cloud

SSL

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


プロパティ説明
SSLServerCertTLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
CData Cloud

SSLServerCert

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

データ型

string

デフォルト値

""

解説

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:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

CData Cloud

Logging

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


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

Verbosity

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

データ型

string

デフォルト値

"1"

解説

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

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

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

CData Cloud

Schema

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


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

BrowsableSchemas

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

データ型

string

デフォルト値

""

解説

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

CData Cloud

Miscellaneous

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


プロパティ説明
MaxRows集計やGROUP BY を含まないクエリで返される最大行数を指定します。
Pagesizeprovider がSurveyMonkey にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。
PseudoColumnsテーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ReplaceNullValuesForPKUpdate NULL values to 0 for primary keys
ShowCustomVariablesA boolean determining if custom variables and their values should be listed when querying Survey_Responses.
ThrowsKeyNotFound更新された行がない場合に例外をスローするかどうかを指定します。
Timeoutprovider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseSimpleNamesテーブルとカラムに簡略名を使用するかどうかを指定します。
CData Cloud

MaxRows

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

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

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

CData Cloud

Pagesize

provider がSurveyMonkey にデータをリクエストするときに返す、ページあたりの最大レコード数を指定します。

データ型

int

デフォルト値

100

解説

クエリを処理する際、SurveyMonkey でクエリされたデータすべてを一度にリクエストする代わりに、Cloud はクエリされたデータをページと呼ばれる部分ごとにリクエストすることができます。

この接続プロパティは、Cloud がページごとにリクエストする結果の最大数を決定します。

Note:大きなページサイズを設定すると全体的なクエリ実行時間が短縮される可能性がありますが、その場合、クエリ実行時にCloud がより多くのメモリを使用することになり、タイムアウトが発生するリスクがあります。

CData Cloud

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

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

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:

*=*

CData Cloud

ReplaceNullValuesForPK

Update NULL values to 0 for primary keys

データ型

bool

デフォルト値

true

解説

When set to true null values for composite keys will be replaced with 0. This property affects only the SurveyQuestions and SurveyAnswers views

CData Cloud

ShowCustomVariables

A boolean determining if custom variables and their values should be listed when querying Survey_Responses.

データ型

bool

デフォルト値

true

解説

A boolean determining if custom variables and their values should be listed when querying Survey_Responses.

CData Cloud

ThrowsKeyNotFound

更新された行がない場合に例外をスローするかどうかを指定します。

データ型

bool

デフォルト値

false

解説

更新された行がない場合に例外をスローするかどうかを指定します。

CData Cloud

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

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

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

CData Cloud

UseSimpleNames

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

データ型

bool

デフォルト値

false

解説

SurveyMonkey テーブルでは、標準的なデータベースでは通常許可されない特殊文字を名前に含めることができます。このプロパティを使用すると、Cloud を従来のデータベースツールでより簡単に使用できるようになります。

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

Notes:

  • 英数字以外の文字はアンダースコアに置き換えられます。
  • カラム名やテーブル名が128 文字を超える場合は、SQL Server 標準に準拠するために128文字に切り詰められます。

CData Cloud

Third Party Copyrights

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.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 25.0.9540