CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるSurveyMonkey へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してSurveyMonkey に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、SurveyMonkey への接続を標準化し、構成することができます。
このページでは、CData Cloud でのSurveyMonkey への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのSurveyMonkey への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してSurveyMonkey からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、SurveyMonkey に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
個人用アクセストークンを取得したら、以下のプロパティを設定します。
すべての認証フローで、OAuth 経由で接続するにはAuthScheme をOAuth に設定する必要があります。(これは、接続に埋め込みOAuth 認証情報を使用するか、カスタムOAuth アプリケーションを作成するかに関係なく適用されます。)
以下のサブセクションでは、利用可能なOAuth フローでのSurveyMonkey への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成についての情報と、すでに埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成 を参照してください。
SurveyMonkey で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。
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:
The Cloud offers the possibility to select surveys as relational tables.
You can create your own Surveys by performing the following steps:
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
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
デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
アカウント内の任意のアンケートや関連データにアクセスできます。CData Cloud は、SurveyMonkey API のエンティティをテーブル、ビュー、およびストアドプロシージャにモデル化します。
これらはスキーマファイルにて定義されます。スキーマファイルは、スキーマを簡単に拡張できるシンプルな形式のコンフィギュレーションファイルです。
Cloud は、SurveyMonkey API にできるだけ多くのSELECT 構文処理をオフロードし、残りのクエリをCloud 内で処理します。次のセクションでは、API の制限と要件を説明します。
Cloud は、アンケートおよび分析をリレーショナルビュー としてモデル化します。ビューは、一般的には読み取り専用のテーブルです。
ストアドプロシージャ は、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
CollectorMessages | Shows information regarding messages sent from a collector. |
CollectorRecipients | Shows information regarding recipients of all or specific messages sent from a collector. |
Collectors | Shows collector information. |
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. |
Surveys | Shows information regarding surveys. |
Shows information regarding messages sent from a collector.
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'
Name | Type | Description |
Id [KEY] | String | The Id of the message. |
CollectorId | String | The Id of the collector this message belongs to. |
Status | String | The status of this message. |
Type | String | Message type: 'invite', 'reminder', or 'thank_you'. |
Subject | String | The subject of this message. Only available if resource is being queried by Id. |
Body | String | The html body of this message. Only available if resource is being queried by Id. |
DateCreated | Datetime | Date message was created. Only available if resource is being queried by Id. |
ScheduledDate | Datetime | Date message is scheduled to be sent. If Null, message has not been scheduled to send. Only available if resource is being queried by Id. |
EmbedFirstQuestion | Boolean | 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 this message. Only available if resource is being queried by Id. |
IsBrandingEnabled | Boolean | Whether branding is enabled for this message. Only available if resource is being queried by Id. |
IsScheduled | Boolean | Whether this message is scheduled. Only available if resource is being queried by Id. |
RecipientStatus | String | Recipient filter: 'reminder' or 'thank_you'. Only available if resource is being queried by Id. |
Shows information regarding recipients of all or specific messages sent from a collector.
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 CollectorRecipients WHERE CollectorId = '175305200' SELECT * FROM CollectorRecipients WHERE CollectorId = '175305200' AND MessageId = '57071816' SELECT * FROM CollectorRecipients WHERE CollectorId = '175305200' AND Id = '4496877899'
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. |
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. |
Shows collector information.
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.
For example, the following queries are processed server side:
SELECT * FROM Collectors WHERE SurveyId = '126748712' SELECT * FROM Collectors WHERE Id = '175305200'
Name | Type | Description |
Id [KEY] | String | The Id of the collector. |
SurveyId | String | The Id of the Survey this collector belongs to. Only shows up if filtering Collectors by SurveyId. |
Name | String | The name of the collector. |
Status | String | Collector status: 'open' or 'closed'. Only available if resource is being queried by Id. |
Type | String | Collector type: 'weblink' or 'email'. Only available if resource is being queried by Id. |
ThankYouMessage | String | Message for thank you page. Only available if resource is being queried by Id. |
DisqualificationMessage | String | Message for disqualification page. Only available if resource is being queried by Id. |
ClosedPageMessage | String | Message shown when someone visits a closed survey. Only available if resource is being queried by Id. |
DisplaySurveyResults | Boolean | Shows respondents survey instant results when they complete the survey. Only available if resource is being queried by Id. |
EditResponseTypes | String | When respondents can edit their response: 'until_complete', 'never', or 'always'. Only available if resource is being queried by Id. |
AnonymousType | String | Turns off IP tracking. For email collectors, also removes respondent email address and name from response: 'not_anonymous', 'partially_anonymous', 'fully_anonymous'. Only available if resource is being queried by Id. |
SenderEmail | String | Sender email for email collectors. User's email is used if null. Only available if resource is being queried by Id. |
Url | String | If collector is a Web Collector (type 'weblink') then the url for the collector. Only available if resource is being queried by Id. |
RedirectType | String | Determines survey end page behavior: 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 | Redirects respondent to this url upon survey completion. Only available if resource is being queried by Id. |
AllowMultipleResponses | Boolean | Allows respondents to take a survey more than once from the same browser on the same computer. Only available for weblink collectors. Only available if resource is being queried by Id. |
PasswordEnabled | Boolean | True if the collector is password protected. Only available for weblink collectors. Only available if resource is being queried by Id. |
DateModified | Datetime | Date collector was last modified. Only available if resource is being queried by Id. |
DateCreated | Datetime | Date collector was created. Only available if resource is being queried by Id. |
CloseDate | Datetime | Close date of collector. Only available if resource is being queried by Id. |
Shows statistics regarding all or specific messages sent from a collector.
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'
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. |
Shows contact list information.
For example, the following queries are processed server side:
SELECT * FROM ContactLists WHERE Id = '123740269'
Name | Type | Description |
Id [KEY] | String | The Id of the contact list. |
Name | String | The name of the contact list. |
Shows contact information.
For example, the following queries are processed server side:
SELECT * FROM Contacts WHERE Id = '2842583326' SELECT * FROM Contacts WHERE ContactListId = '123679423'
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. |
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. |
Shows information regarding pages for a survey.
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'
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. |
Shows rolled up individual stats information for a survey.
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'
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. |
Shows rolled up stats information for a survey.
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'
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. |
Shows the available columns for Survey Questions. Append _Questions to your survey name to query survey questions.
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]
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. |
Shows the available columns for Survey Responses. Append _Responses to your survey name to query survey responses.
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:
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.
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). |
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. |
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. |
Shows information regarding surveys.
Name | Type | Description |
Id [KEY] | String | The Id of the survey. |
Title | String | The title of the survey. |
Nickname | String | The nickname of the survey. |
Category | String | The Category of the survey. |
DateCreated | Datetime | The Date that the survey was created. |
DateModified | Datetime | The Date that the survey was modified. |
FolderId | String | If specified, adds the survey to the folder with that id. |
IsOwner | Boolean | Is Owner of the survey. |
Language | String | Language of the survey. |
QuestionCount | Int | The number of questions in survey. |
ResponseCount | Int | The number of responses survey has received. |
ストアドプロシージャはファンクションライクなインターフェースで、SurveyMonkey の単純なSELECT 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSurveyMonkey から関連するレスポンスデータを返します。
Name | Description |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、SurveyMonkey のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | データベース名。 |
利用可能なスキーマをリストします。
次のクエリは、すべての利用可能なスキーマを取得します。
SELECT * FROM sys_schemas
Name | Type | Description |
CatalogName | String | データベース名。 |
SchemaName | String | スキーマ名。 |
利用可能なテーブルをリストします。
次のクエリは、利用可能なテーブルおよびビューを取得します。
SELECT * FROM sys_tables
Name | Type | Description |
CatalogName | String | テーブルまたはビューを含むデータベース。 |
SchemaName | String | テーブルまたはビューを含むスキーマ。 |
TableName | String | テーブル名またはビュー名。 |
TableType | String | テーブルの種類(テーブルまたはビュー)。 |
Description | String | テーブルまたはビューの説明。 |
IsUpdateable | Boolean | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、MySurvey_Responses テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='MySurvey_Responses'
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 から返されたフィールドがテーブルの主キーであるかどうか。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベース。 |
SchemaName | String | ストアドプロシージャを含むスキーマ。 |
ProcedureName | String | ストアドプロシージャの名前。 |
Description | String | ストアドプロシージャの説明。 |
ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、SelectEntries ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
ColumnName | String | ストアドプロシージャパラメータの名前。 |
Direction | Int32 | パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | 数値データの小数点以下の桁数。 |
IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
IsArray | Boolean | パラメータが配列かどうか。 |
Description | String | パラメータの説明。 |
Ordinal | Int32 | パラメータのインデックス。 |
主キーおよび外部キーについて説明します。
次のクエリは、MySurvey_Responses テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='MySurvey_Responses'
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 | 主キーのカラム名。 |
外部キーについて説明します。
次のクエリは、他のテーブルを参照するすべての外部キーを取得します。
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 | 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。 |
主キーについて説明します。
次のクエリは、すべてのテーブルとビューから主キーを取得します。
SELECT * FROM sys_primarykeys
Name | Type | Description |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前。 |
KeySeq | String | 主キーのシーケンス番号。 |
KeyName | String | 主キーの名前。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
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 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
このテーブルをクエリする際は、config 接続文字列を使用する必要があります。
jdbc:cdata:surveymonkey:config:
この接続文字列を使用すると、有効な接続がなくてもこのテーブルをクエリできます。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
SELECT * FROM sys_connection_props WHERE Value <> ''
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 | プロパティに関するその他のさまざまな情報。 |
Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。
SQL 構文の詳細については、SQL 準拠 を参照してください。
以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。
名前 | 説明 | 有効な値 |
AGGREGATE_FUNCTIONS | サポートされている集計関数。 | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT | COUNT 関数がサポートされているかどうか。 | 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_BY | GROUP 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_PROPERTIES | Uniform データベースを特定するプロパティを示します。 | |
SUPPORTS_MULTIPLE_SCHEMAS | プロバイダー用に複数のスキームが存在するかどうかを示します。 | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS | プロバイダー用に複数のカタログが存在するかどうかを示します。 | YES, NO |
DATASYNCVERSION | このドライバーにアクセスするために必要な、CData Sync のバージョン。 | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY | このドライバーのCData Sync カテゴリ。 | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL | API で提供されている以上の、追加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_PARENTID | CheckCache 構文を親キーカラムに対して実行するかどうかを示します。 | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES | スキーマファイルの生成に使用できる、ストアドプロシージャを示します。 |
次のクエリは、WHERE 句で使用できる演算子を取得します。
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
Name | Type | Description |
NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
Name | Type | Description |
Id | String | データ変更処理から返された、データベース生成Id。 |
Batch | String | バッチの識別子。1 は単一処理。 |
Operation | String | バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。 |
Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
プロパティ | 説明 |
AuthScheme | The type of authentication to use when connecting to SurveyMonkey. |
AccessToken | The Access Token of the SurveyMonkey application. |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuthAccessToken | OAuth を使用して接続するためのアクセストークン。 |
Scope | The Scope supplied from the app settings. |
AccessURL | The URL to get the data from. Depends on the originating datacenter of the SurveyMonkey account. |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Pagesize | SurveyMonkey から返されるページあたりの結果の最大数。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
ShowCustomVariables | A boolean determining if custom variables and their values should be listed when querying Survey_Responses. |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AuthScheme | The type of authentication to use when connecting to SurveyMonkey. |
AccessToken | The Access Token of the SurveyMonkey application. |
The type of authentication to use when connecting to SurveyMonkey.
string
"OAuth"
The Access Token of the SurveyMonkey application.
string
""
The Access Token of the SurveyMonkey application.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
OAuthAccessToken | OAuth を使用して接続するためのアクセストークン。 |
Scope | The Scope supplied from the app settings. |
AccessURL | The URL to get the data from. Depends on the originating datacenter of the SurveyMonkey account. |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
string
""
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
string
""
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
OAuth を使用して接続するためのアクセストークン。
string
""
OAuth を使用して接続するには、OAuthAccessToken プロパティが使用されます。認証プロセスにおいてOAuth サーバーからOAuthAccessToken が取得されます。このプロパティは、サーバーに依存するタイムアウトがあり、要求の間で再利用することができます。
アクセストークンは、ユーザー名とパスワードの代わりに使用されます。サーバー上で維持することで、認証情報が保護されます。
The Scope supplied from the app settings.
string
""
The Scope supplied from the app settings. Recommended to be specified when using a custom app.
The URL to get the data from. Depends on the originating datacenter of the SurveyMonkey account.
string
""
The URL to get the data from. Depends on the originating datacenter of the SurveyMonkey account. By default takes the value returned when performing the GetOAuthAccessToken procedure. Change this if you are using the AccessToken AuthScheme and your accounts datacenter AccessURL is different from https://api.surveymonkey.net.
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
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 |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Pagesize | SurveyMonkey から返されるページあたりの結果の最大数。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
ShowCustomVariables | A boolean determining if custom variables and their values should be listed when querying Survey_Responses. |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
int
-1
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
SurveyMonkey から返されるページあたりの結果の最大数。
int
100
Pagesize プロパティは、SurveyMonkey から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
string
""
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
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.
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
int
60
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。
テーブルとカラムに簡略名を使用するかどうかを決定するboolean。
bool
false
SurveyMonkey テーブルおよびカラムでは、 通常のデータベースでは使うことが認められていない特殊記号・文字を名前に使うことができます。UseSimpleNames を使用すると、Cloud を従来のデータベースツールでより簡単に使用できるようになります。
UseSimpleNames をtrue に設定し、返されるテーブル名およびカラム名をシンプルにします。表示されるテーブル名 およびカラム名においてアルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。 英数字以外の文字はすべて、アンダースコアに変換されます。