CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるGmail へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してGmail に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、Gmail への接続を標準化し、構成することができます。
このページでは、CData Cloud でのGmail への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのGmail への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してGmail からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、Gmail に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
この認証方法を使うには、AuthScheme をBasic に、Schema をIMAP に設定します。このアプローチは、自分のデータにアクセスする必要がある場合に適しています。User プロパティとPassword プロパティに、有効なGmail ユーザー資格情報を設定します。
NOTE： CData は、OAuth 認証でIMAP およびREST の両方のスキーマをサポートしています。唯一の違いは、IMAP はUser 接続プロパティを必要とすることです。REST では必要ありません。
次の接続プロパティを設定し、OAuthAccessToken を取得します。
続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。
アクセストークンとリフレッシュトークンを取得した後、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることが可能です。
OAuth アクセストークンの自動リフレッシュ
ドライバーがOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。
OAuth アクセストークンの手動リフレッシュ
データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。
GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用し、手動でOAuthAccessToken をリフレッシュします。次の接続プロパティを設定します。
次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。
最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。
オプション1：Verifier code を取得および交換
Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。
インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。
ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。
OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。
オプション2：OAuth 設定を転送
ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバとの接続を作成し、インストールする必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。
「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。
接続が正常にテストされたら、OAuth 設定ファイルをヘッドレスマシンにコピーします。
ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。
GCP 仮想マシン上で実行している場合は、Cloud は仮想マシンに関連付けられたサービスアカウントを使用して認証できます。 このモードを使用するには、AuthScheme をGCPInstanceAccount に設定します。
デスクトップアプリケーション、Web アプリケーション、ヘッドレスマシンには、OAuth カスタムアプリケーションが必要です。
次の手順に従ってアプリを登録し、OAuthClientId およびOAuthClientSecret を取得します。
下記の手順に従って、OAuthClientId およびOAuthClientSecret を取得します。
次の手順に従ってOAuth アプリケーションを作成しプライベートキーを作成します。
デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
CData Cloud は、Gmail エンティティをリレーショナルテーブルおよびストアドプロシージャにモデル化します。 このセクションでは、API の制限および要件について説明します。既定の SupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
Gmail REST データモデル では、Gmail REST アカウントへの接続に使用できるスキーマについて説明します。テーブルを使用して、ライブGmail データを操作できます。CData Cloud が提供するストアドプロシージャを使用して、Gmail データの操作を自動化できます。
Gmail IMAP データモデル では、Gmail IMAP アカウントへの接続に使用できるスキーマについて説明します。テーブルを使用して、ライブGmail データを操作できます。CData Cloud が提供するストアドプロシージャを使用して、Gmail データの操作を自動化できます。
テーブル では、利用可能なテーブルを説明します。テーブルはLabels とMessages をモデル化するために静的に定義されています。
Labels はスタンドアローンのテーブルとして公開されており、そのラベル内にリストされたすべてのメッセージを取得できます。次に例を示します：INBOX、SENT、DRAFT など。
ビュー では、利用可能なビューを説明します。テーブルはAttachments、Filters、History などをモデル化するために静的に定義されています。
ストアドプロシージャ は、Gmail のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、OAuth アクセストークンの取得など、Gmail の操作を実行できます。
Query Labels in Gmail.
利用可能なLabels をクエリします。
ドライバーはGmail REST API を使用して、Id カラムを参照する検索条件を処理します。ドライバーは他のフィルタを、ドライバー内のクライアントサイドで処理します。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Labels WHERE Id = 'abc'
簡単なラベルを挿入します。
INSERT INTO [Labels] (Name) VALUES ('LabelName')
ラベルを削除します。
DELETE FROM [Labels] WHERE Id = 'LabelId'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The immutable ID of the label. | |
| Name | String | False |
The display name of the label. | |
| MessageListVisibility | String | False |
The visibility of messages with this label in the message list in the Gmail web interface. Acceptable values: HIDE, SHOW. | |
| LabelListVisibility | String | False |
The visibility of the label in the label list in the Gmail web interface. Acceptable values: LabelHide, LabelShow, LabelShowIfUnread. | |
| Type | String | True |
The owner type for the label. | |
| MessagesTotal | Long | True |
The total number of messages with the label. | |
| ThreadsTotal | Long | True |
The total number of threads with the label. | |
| MessagesUnread | Long | True |
The number of unread messages with the label. | |
| ThreadsUnread | Long | True |
The number of unread threads with the label. |
Query Messages in Gmail.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The Id of the message. Automatically assigned when the mail is created. | |
| Subject | String | False |
The subject of the email. | |
| From | String | False |
The address where the email is from. | |
| To | String | False |
The address where the email is sent to. | |
| Content | String | False |
The content of the email. | |
| Date | Datetime | False |
The date when the email is sent. | |
| Size | Long | False |
The size in bytes of the email. | |
| Labels | String | False |
A comma separated list of labels that the email is part of. | |
| AttachmentIds | String | False |
A comma separated value of the ids of all attachments in the email. | |
| AttachmentPath | String | False |
The path of the attachment. | |
| Snippet | String | False |
The snippet of the email. | |
| ThreadId | String | False |
The thread id of the email. | |
| HistoryId | String | False |
The history id of the email. | |
| Headers | String | False |
A list of headers of the email. | |
| RawMessage | String | False |
The entire email message in an RFC 2822 formatted and base64url encoded string. Only returned when MessageFormat=raw. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| IncludeSpamTrash | String |
Include messages from SPAM and TRASH in the results. (Default: false) |
| MessageFormat | String |
The format to return the message in: minimal, full, raw, or metadata. (Default: full) |
| LabelsFilter | String |
Set this to a comma-separated list of labels that the email should be part of. |
| SearchQuery | String |
Only return messages matching the specified query. Supports the same query format as the Gmail search box. This will take precedence over any other SQL criteria. |
Query SENT Messages in Gmail.
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | False |
The identifier of the mail message. | |
| Subject | String | False |
The subject of the current message. | |
| From | String | False |
The sender email address of the current message. | |
| To | String | False |
The email address of the recipient. | |
| CC | String | False |
CCed recipient. | |
| BCC | String | False |
BCCed recipient. | |
| Content | String | False |
The content of the email. | |
| Date | Datetime | False |
The date and time the current message was sent. | |
| Size | Long | False |
The size in bytes of the current message. | |
| Labels | String | False |
A comma separated list of labels that the email is part of. | |
| AttachmentIds | String | False |
A comma-separated list of the attachment ids. | |
| AttachmentPath | String | False |
A comma-separated list of the attachments content. Used in INSERT to set the local path of the file to attach. | |
| Snippet | String | False |
A snippet of the message. | |
| ThreadId | String | False |
The thread ID of the email. | |
| HistoryId | String | False |
The history id of the email. | |
| Headers | String | False |
A list of headers of the email. | |
| RawMessage | String | False |
The entire email message in an RFC 2822 formatted and base64url encoded string. Only returned when MessageFormat=raw. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| IncludeSpamTrash | String |
Include messages from SPAM and TRASH in the results. (Default: false) |
| MessageFormat | String |
The format to return the message in: minimal, full, raw, or metadata. (Default: full) |
| LabelsFilter | String |
Set this to a comma-separated list of labels that the email should be part of. |
| SearchQuery | String |
Only return messages matching the specified query. Supports the same query format as the Gmail search box. This will take precedence over any other SQL criteria. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
| Name | Description |
| Attachments | Query Attachments in Gmail. |
| Filters | Query Filters in Gmail. |
| History | Query History in Gmail. |
| INBOX | Query SENT Messages in Gmail. |
| Threads | Query Threads in Gmail. |
| Users | Query Users in Gmail. |
Query Attachments in Gmail.
利用可能なAttachments をクエリします。
ドライバーはGmail REST API を使用して、MessageId とIncludeAttachmentData カラムを参照する検索条件を処理します。ドライバーは他のフィルタを、ドライバー内のクライアントサイドで処理します。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Attachments WHERE MessageId = 123 SELECT * FROM Attachments WHERE IncludeAttachmentData = true
| Name | Type | References | Description |
| Id [KEY] | String | The X-Attachment-Id of the message part header. | |
| MessageId [KEY] | String | The ID of the message containing the attachment. | |
| Filename | String | The name of the attachment file. | |
| Size | Long | The size in bytes of the attachment. | |
| Data | String | The conent of the attachment. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| IncludeAttachmentData | Boolean | A boolean controling whether to include the attachment data or not. (Default: true) |
Query Filters in Gmail.
利用可能なFilters をクエリします。
ドライバーはGmail REST API を使用して、Id カラムを参照する検索条件を処理します。ドライバーは他のフィルタを、ドライバー内のクライアントサイドで処理します。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM Filters WHERE ID = 123
| Name | Type | References | Description |
| Id [KEY] | String | The server assigned ID of the filter. | |
| AddLabelIds | String | List of labels to add to the message. | |
| RemoveLabelIds | String | List of labels to remove from the message. | |
| Forward | String | Email address that the message should be forwarded to. | |
| From | String | The sender's display name or email address. | |
| To | String | The recipient's display name or email address. Includes recipients in the | |
| Subject | String | Case-insensitive phrase found in the message's subject. | |
| Query | String | Only return messages matching the specified query. Supports the same query format as the Gmail search box. | |
| NegatedQuery | String | The primary email address of the user. Writeable on create only. On update, a secondary email is added. | |
| HasAttachment | Boolean | Whether the message has any attachment. | |
| ExcludedChats | Boolean | Whether the response should exclude chats. | |
| Size | Integer | The size of the entire RFC822 message in bytes, including all headers and attachments. | |
| SizeComparison | String | How the message size in bytes should be in relation to the size field. |
Query History in Gmail.
利用可能なHistory をクエリします。
ドライバーはGmail REST API を使用して、Id カラムを参照する検索条件を処理します。ドライバーは他のフィルタを、ドライバー内のクライアントサイドで処理します。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM History WHERE Id > 123
| Name | Type | References | Description |
| Id [KEY] | Long | The ID of the mailbox's current history record. | |
| MessagesAdded | String | Messages added to the mailbox in this history record. | |
| MessagesDeleted | String | Messages deleted (not Trashed) from the mailbox in this history record. | |
| LabelsAdded | String | Labels added to messages in this history record. | |
| LabelsRemoved | String | Labels removed from messages in this history record. |
Query SENT Messages in Gmail.
利用可能なINBOX をクエリします。
ドライバーはGmail REST API を使用して、Id、Subject、From、To、Date、ThreadId、IncludeSpamTrash、MessageFormat、LabelsFilter、SearchQuery カラムを参照する検索条件を処理します。ドライバーは他のフィルタを、ドライバー内のクライアントサイドで処理します。
例えば、次のクエリはサーバーサイドで処理されます。
SELECT * FROM INBOX WHERE Id = '123' SELECT * FROM INBOX WHERE Subject = '123' SELECT * FROM INBOX WHERE [From] = '[email protected]' SELECT * FROM INBOX WHERE [To] = '[email protected]' SELECT * FROM INBOX WHERE [Date] >= '12/12/12 12:12:12' SELECT * FROM INBOX WHERE [ThreadId] = '123' SELECT * FROM INBOX WHERE [IncludeSpamTrash] = 'true' SELECT * FROM INBOX WHERE [MessageFormat] = 'raw' SELECT * FROM INBOX WHERE [LabelsFilter] = 'IMPORTANT, STARRED' SELECT * FROM INBOX WHERE [SearchQuery] = 'from:[email protected]'
| Name | Type | References | Description |
| Id [KEY] | String | The identifier of the mail message. | |
| Subject | String | The subject of the current message. | |
| From | String | The sender email address of the current message. | |
| To | String | The email address of the recipient. | |
| CC | String | CCed recipient. | |
| BCC | String | BCCed recipient. | |
| Content | String | The content of the email. | |
| Date | Datetime | The date and time the current message was sent. | |
| Size | Long | The size in bytes of the current message. | |
| Labels | String | A comma separated list of labels that the email is part of. | |
| AttachmentIds | String | A comma-separated list of the attachment ids. | |
| AttachmentPath | String | A comma-separated list of the attachments content. Used in INSERT to set the local path of the file to attach. | |
| Snippet | String | A snippet of the message. | |
| ThreadId | String | The thread ID of the email. | |
| HistoryId | String | The history id of the email. | |
| Headers | String | A list of headers of the email. | |
| RawMessage | String | The entire email message in an RFC 2822 formatted and base64url encoded string. Only returned when MessageFormat=raw. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| IncludeSpamTrash | String | Include messages from SPAM and TRASH in the results. (Default: false) | |
| MessageFormat | String | The format to return the message in: minimal, full, raw, or metadata. (Default: full) | |
| LabelsFilter | String | Set this to a comma-separated list of labels that the email should be part of. | |
| SearchQuery | String | Only return messages matching the specified query. Supports the same query format as the Gmail search box. This will take precedence over any other SQL criteria. |
Query Threads in Gmail.
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the thread. | |
| HistoryID | String | The Id of the last history record that modified this thread. | |
| Snippet | String | A short part of the message text. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description | |
| LabelsFilter | String | Set this to a comma-separated list of labels that the thread should be part of. | |
| IncludeSpamTrash | String | Include threads from SPAM and TRASH in the results. (Default: false) |
Query Users in Gmail.
| Name | Type | References | Description |
| EmailAddress | String | The email address of the user. | |
| MessagesTotal | String | The total number of messages. | |
| ThreadsTotal | String | The total number of threads. | |
| HistoryId | String | The Id of the history. |
ストアドプロシージャはファンクションライクなインターフェースで、Gmail の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにGmail から関連するレスポンスデータを返します。
| Name | Description |
| SendMailMessage | Sends a message to the specified recipient. |
Sends a message to the specified recipient.
このプロシージャを使用してE メールを送信します。
ファイルを1つだけ添付する例です。
EXECUTE SendMailMessage @Subject = 'subject', @To = 'email', @CC = 'email', @Content = 'content', @AttachmentPath = 'C:\\MyDirectory\\MyFile.extension'
ディレクトリの最初の階層の、すべてのファイルを添付する例です。
EXECUTE SendMailMessage @Subject = 'subject', @To = 'email', @CC = 'email', @Content = 'content', @AttachmentPath = 'C:\\MyDirectory'
複数のファイルとフォルダを、組み合わせて添付する例です。
INSERT INTO attach#TEMP (AttachmentPath) VALUES ('C:\\MyDirectory\\MyFile.extension')
INSERT INTO attach#TEMP (AttachmentPath) VALUES ('C:\\MyDirectory2')
EXECUTE SendMailMessage @Subject = 'subject', @To = 'email', @CC = 'email', @Content = 'content', @AttachmentPath = 'attach#TEMP'
複数のメール受信者を含める場合の例です。
EXECUTE SendMailMessage @Subject = 'subject', @To = '[email protected],[email protected]', @CC = '[email protected],[email protected]', @Content = 'content'
| Name | Type | Required | Description |
| To | String | True | The email address(es) of the recipient(s). |
| From | String | False | The email address of the sender. |
| Subject | String | True | The subject of the mail message. |
| Content | String | True | The message body. |
| CC | String | False | CCed recipient(s). |
| BCC | String | False | BCCed recipient(s). |
| AttachmentPath | String | False | The attachment file names (with the path if reading from a file) to include in the message. |
| Name | Type | Description |
| Id | String | The Id for the message as returned by the server. |
ストアドプロシージャ は、Gmail のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、OAuth アクセストークンを取得するなどの、Gmail への操作を実行できます。
Note：ストアドプロシージャへの入力としてGmail のデフォルトのメールボックスを参照している場合には、メールボックスを正しいフォーマットで記述してください。例えば、[Gmail]/送信済みメール です。
Cloud はGmail のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| MailMessages | Create, update, delete, and query Gmail messages. |
Create, update, delete, and query Gmail messages.
NOTE：このスキーマはすべてのテーブルに定義されます。すべてのテーブル名はサーバーのメールボックスフォルダです。
NOTE：E メールが特殊文字を含む場合には、メッセージボディ内の本文はbase64 でエンコードされます。デコードされたメッセージを取得するには、メッセージボディの本文をデコードするか、GetPart ストアドプロシージャを使用します。
このテーブルに含まれるE メールアドレスフィールドは、次のフォーマットを受け付けます：
SELECT * FROM [Gmail/All Mail]
特定のメールボックス内のメッセージをリストするには、メールボックスをテーブルとして指定します。E メールは、新しいものから古いものの順でリストされます。別の方法として、メッセージID の範囲を指定することができます。範囲で使用可能なフォーマットは以下のとおりです。
SELECT * FROM [Inbox] WHERE Id = 10
SELECT * FROM [Inbox] WHERE Id BETWEEN 10 AND 20
SELECT * FROM [Inbox] WHERE Id IN (1, 3, 5)
Cloud はE メールを検索する方法をいくつか提供します。下記のソースの検索条件を、SELECT クエリのWHERE 句で使用できます。
To、From、BCC、CC、Subject、およびMessageBody は、次の演算子でフィルタ可能です：=、!=、CONTAINS。
Flags とLabels は、= および!= 演算子のみをサポートします。
Date は次の演算子でフィルタ可能です：=、<、<=、>、>=。
Size は、< および> 演算子のみをサポートします。
CONTAINS 関数には、UI の検索バーと同様に完全な単語（例えば、Tes ではなくTest）が必要であることに注意してください。
例えば、以下のクエリは[email protected] または[email protected] のいずれかから、テキスト'Test' を含むすべてのメッセージを返します。
SELECT * FROM [Gmail/All Mail] WHERE CONTAINS(MessageBody, "Test") AND ([From] = [email protected] OR [From] = [email protected]) AND Date > '1-1-2012'
SELECT * FROM [Gmail/All Mail] WHERE HasAttachment = 'True' AND Attachments = '.txt'
Insert ステートメントはE メールの送信に使用します。Subject、To、およびMessageBody フィールドは必須です。
INSERT INTO [Gmail/All Mail] (Subject, MessageBody, To) VALUES ('Test Subject', 'Body Text', '[email protected]')
UPDATE [Inbox] SET Mailbox = 'NewMailboxName' WHERE Id = 'MessageId'ID はメッセージ番号、':' で区切られた2つのメッセージ番号の範囲（例えば、"1:5"）、または',' で区切られた個別のメッセージ番号（例えば、"1:5,7,10"）を含むことができます。
UPDATE [Inbox] SET Flags = 'Seen' WHERE Id = 'MessageId'
IMAP RFC で指定されているフラグの標準値は次のとおりです：'Answered'、'Flagged'、'Deleted'、'Seen'、および'Draft'。
クエリで指定されたフラグは、すべてのE メールの現在のフラグをオーバーライドします。
IMAP を使用してGmail からメッセージを削除する場合、メッセージはサーバーからは削除されません。Gmail は現在の受信トレイのラベルを削除して、E メールを"archived" としてマークします。 すべてのフォルダからメッセージを永久に削除したい場合には：
Id フィールドが必要です。
DELETE FROM [Inbox] WHERE Id = '2'
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
The identifier of the mail message. | |
| Mailbox | String | False |
The current mailbox that the item is listed in. Updating this value moves the message to a new mailbox. | |
| Subject | String | False |
The subject of the current message. | |
| FullFrom | String | True |
The sender name and email address of the current message. | |
| From | String | True |
The sender email address of the current message. | |
| FullTo | String | True |
A semicolon-separated list of names and email addresses of the recipients. | |
| To | String | False |
A semicolon-separated list of the email addresses of the recipients. | |
| FullCC | String | True |
A semicolon-separated list of names and email addresses of the CC'd recipients. | |
| CC | String | False |
A semicolon-separated list of the email addresses of the CC'd recipients. | |
| FullBCC | String | True |
A semicolon-separated list of the names and email addresses of the BCC'd recipients. This field is only applicable for sent mail. | |
| BCC | String | False |
A semicolon-separated list of the email addresses of the BCC'd recipients. This field is only applicable for sent mail. | |
| Date | Datetime | True |
The date and time the current message was sent. | |
| MessageBody | String | False |
The message body. This field can only be set if you specify a single Id in SELECT. | |
| Attachments | String | False |
A semicolon-separated list of the attachment file names (with the path specified if reading from a file) included in the message. | |
| AttachmentData | String | False |
A semicolon-separated list of the base-64-encoded attachment data included in the message. The file name in the Attachments field must also be specified to use this field. | |
| Size | Int | True |
The size in bytes of the current message. | |
| Flags | String | False |
The flags set on the current message. | |
| Labels | String | False |
The labels of the message, separated by spaces. Gmail treats labels as mailboxes. | |
| ThreadId | String | True |
The Gmail thread Id associated with the current message. Several messages may have the same thread Id. | |
| MsgId | String | True |
The Gmail message Id associated with the current message. This is a globally unique Id assigned by Google separate from the IMAP Id/UID. | |
| PartIds | String | True |
The Id of the message part. | |
| PartFilenames | String | True |
The file name of the message part. | |
| PartContentTypes | String | True |
The content type of the message part. | |
| PartSizes | String | True |
The size of the message part. | |
| Headers | String | True |
The message headers for the specified mail message. This field is only available if you specify a single Id in SELECT or set IncludeMessage connection property to true. | |
| AttachmentHeaders | String | True |
The attachment headers for the specified mail message. This field is only available if you specify a single Id in SELECT or set IncludeMessage connection property to true. | |
| ContentIds | String | True |
The content id headers for the specified mail message. This field is only available if you specify a single Id in SELECT or set IncludeMessage connection property to true. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| SearchCriteria | String |
The search criteria to use for the search operation (i.e., SENTSINCE dd-MMM-yyyy). The IMAP RFCs specifies the exact format of the search criteria. The string consists of one or more search keys and their corresponding values, if any, separated by spaces. For example: 'SINCE 1-Feb-1994 NOT FROM Smith'. |
| ItemsPerPage | String |
The maximum number of items to return per page. デフォルト値は25です。 |
| IsHTML | String |
This field sets whether the email has an HTML or plain-text encoding. デフォルト値はTRUEです。 |
| Importance | String |
The importance of the mail message. 使用できる値は次のとおりです。UNSPECIFIED, LOW, NORMAL, HIGH デフォルト値はUNSPECIFIEDです。 |
| Priority | String |
The priority of the mail message. 使用できる値は次のとおりです。UNSPECIFIED, NONURGENT, URGENT, NORMAL デフォルト値はUNSPECIFIEDです。 |
| Sensitivity | String |
The sensitivity of the mail message. 使用できる値は次のとおりです。UNSPECIFIED, PERSONAL, PRIVATE, COMPANYCONFIDENTIAL デフォルト値はUNSPECIFIEDです。 |
| DeliveryNotification | String |
The email address to send a delivery notification to. |
| ReadReceipt | String |
The email address to send a read receipt to. |
| ShowLabels | String |
This field sets whether to show labels or not. デフォルト値はTRUEです。 |
| ShowThreadId | String |
This field sets whether to show the thread Id or not. デフォルト値はTRUEです。 |
| ShowMsgId | String |
This field sets whether to show the unique Gmail Id or not. デフォルト値はTRUEです。 |
| UIDMode | String |
If this value is set to true, permanent message Ids are used instead of the default temporary Ids. デフォルト値はFALSEです。 |
| HasAttachments | String |
If this value is set to true, only messages with attachments are listed. If false, all messages are listed. |
| DownloadAttachments | String |
If true, attachments are downloaded with the messages. Available only when specifying a single message Id or the Include Messages connection property is true. By default organizes attachments in subfolders with the message Id as name. デフォルト値はFALSEです。 |
| AttachmentFolder | String |
The folder that is used for downloading attachments. If this is set, the AttachmentData column does not return any data (that is, returns null) and the attachments are instead be written to disk. NOTE: An error is thrown if filters that cannot be supported server-side are included in the criteria. Please refer to the 'Apply Search Criteria' section for a list of supported filters. |
| EMLFolder | String |
The folder where the complete MIME message, which is saved as an EML file, is downloaded to. If multiple messages are selected, subfolders are created for each message. |
| Overwrite | String |
This field sets whether to overwrite attachments and EML files. デフォルト値はFALSEです。 |
| IncludeMessage | String |
This field sets whether to include the message content in the response. デフォルト値はFALSEです。 |
ストアドプロシージャはファンクションライクなインターフェースで、Gmail の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにGmail から関連するレスポンスデータを返します。
| Name | Description |
| AddMailbox | Adds a mailbox to the authorized Gmail account. |
| DeleteMailbox | Deletes the specified mailbox for the authorized Gmail account. |
| GetPart | Gets the message part specified by LocalFile or PartId from the message specified by Id on the Gmail server. |
| MoveEmails | Moves the messages specified by Ids to the mailbox specified by Mailbox . |
| RenameMailbox | Renames the specified mailbox for the authorized Gmail account. |
| SendMailMessage | Sends the message specified to the specified recipient. |
| SetFlags | Adds or Replaces existing flags with the specified flags. |
| SetLabels | Adds or replaces existing Labels with the specified Labels. |
Adds a mailbox to the authorized Gmail account.
| Name | Type | Required | Description |
| Mailbox | String | True | The name of the mailbox to be created. |
| Name | Type | Description |
| Success | String | Boolean response indicating whether or not the operation was successful. |
Deletes the specified mailbox for the authorized Gmail account.
| Name | Type | Required | Description |
| Mailbox | String | True | The name of the mailbox you wish to delete. |
| Name | Type | Description |
| Success | String | Boolean response indicating whether or not the operation was successful. |
Gets the message part specified by LocalFile or PartId from the message specified by Id on the Gmail server.
| Name | Type | Required | Description |
| Id | String | True | The Id of the message that contains the message part.
デフォルト値は1です。 |
| LocalFile | String | True | The local file where the content of the message part will be written to. |
| Mailbox | String | True | The mailbox where the message is currently located.
デフォルト値はInboxです。 |
| PartFileName | String | False | The part file name of the part to retrieve. Either the PartId or the PartFileName input must be specified. |
| PartId | String | False | The part Id of the part to retrieve. Either the PartId or the PartFileName input must be specified. |
| UIDMode | String | False | If true, permanent message Ids are used instead of the default temporary Ids. |
| Overwrite | String | False | If true, the file specified in LocalFile input will be overwritten. |
| Name | Type | Description |
| ContentType | String | The content type. |
| Size | String | The size of the message part. |
| FileName | String | The file name of the message part. |
Moves the messages specified by Ids to the mailbox specified by Mailbox .
| Name | Type | Required | Description |
| Mailbox | String | True | The mailbox where the message is currently located.
デフォルト値はInboxです。 |
| Id | String | True | This inputs indicates the set of messages to operate on. It may consist of a single message id, a range of messages specified by two message numbers separated by ':' (e.g. '1:5'), and/or individual message numbers separated by ',' (e.g. '1:5,7,10').
デフォルト値は1です。 |
| Destination | String | True | The mailbox where the message will be moved.
デフォルト値はInboxです。 |
| Name | Type | Description |
| Success | String | Boolean response indicating whether or not the operation was successful. |
Renames the specified mailbox for the authorized Gmail account.
| Name | Type | Required | Description |
| Mailbox | String | True | The current name of the mailbox you wish to rename. |
| NewName | String | True | The new name of the mailbox you wish to rename. |
| Name | Type | Description |
| Success | String | Boolean response indicating whether or not the operation was successful. |
Sends the message specified to the specified recipient.
Note：このプロシージャは、インデックス付きパラメータを使用します。 インデックス付きパラメータは、プロシージャの入力として単一のパラメータを複数のインスタンスに提供することを容易にします。
Param# という名前の入力パラメータがあるとします。このようなインデックス付きパラメータの複数のインスタンスを入力するには、次のように実行します。
EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
以下の表では、インデックス付きの入力パラメータは、名前の末尾に '#' 文字が付きます。
| Name | Type | Required | Description |
| To | String | True | A semicolon-separated list of names and email addresses of the recipients. |
| Subject | String | True | The subject of the mail message. |
| From | String | False | The email address of the sender. |
| MessageBody | String | True | The message body. |
| CC | String | False | A semicolon-separated list of names and email addresses of the CCed recipients. |
| BCC | String | False | A semicolon-separated list of names and email addresses of the BCCed recipients. |
| Attachment# | String | False | A semicolon-separated list of the attachment file names (with the path if reading from a file) included in the message. |
| AttachmentData# | String | False | A semicolon-separated list of the base-64-encoded attachment data included in the message. To use this field, you must also specify the file name in Attachments. |
| IsHTML | String | False | Whether the email is HTML or plain text.
デフォルト値はTRUEです。 |
| Importance | String | False | The importance of the mail message.
使用できる値は次のとおりです。UNSPECIFIED, LOW, NORMAL, HIGH デフォルト値はUNSPECIFIEDです。 |
| Priority | String | False | The priority of the mail message.
使用できる値は次のとおりです。UNSPECIFIED, NONURGENT, URGENT, NORMAL デフォルト値はUNSPECIFIEDです。 |
| Sensitivity | String | False | The sensitivity of the mail message.
使用できる値は次のとおりです。UNSPECIFIED, PERSONAL, PRIVATE, COMPANYCONFIDENTIAL デフォルト値はUNSPECIFIEDです。 |
| DeliveryNotification | String | False | The email address to send a delivery notification to. |
| ReadReceipt | String | False | The email address to send a read receipt to. |
| Charset | String | False | The character set to use in the message.
デフォルト値はUTF-8です。 |
| Name | Type | Description |
| MessageId | String | The Id for the message as returned by the server. |
Adds or Replaces existing flags with the specified flags.
| Name | Type | Required | Description |
| Mailbox | String | True | The Gmail mailbox where the message is located.
デフォルト値はInboxです。 |
| Id | String | True | This inputs indicates the set of messages to operate on. It may consist of a single message id, a range of messages specified by two message numbers separated by ':' (e.g. '1:5'), and/or individual message numbers separated by ',' (e.g. '1:5,7,10'). |
| Flags | String | True | Sets the specified flags to the message specified by message set. (e.g., Seen, Deleted, Draft). Flags should be specified as comma separated list(e.g. Seen,Deleted)
デフォルト値はSeenです。 |
| OperationType | String | False | This indicates weather the specified flags should be added,removed or replace existing flags list.
使用できる値は次のとおりです。ADD, REPLACE, REMOVE デフォルト値はREPLACEです。 |
| Name | Type | Description |
| Success | String | Boolean response indicating whether or not the operation was successful. |
Adds or replaces existing Labels with the specified Labels.
| Name | Type | Required | Description |
| Mailbox | String | True | The Gmail mailbox where the message is located.
デフォルト値はInboxです。 |
| Id | String | True | This inputs indicates the set of messages to operate on. It may consist of a single message id, a range of messages specified by two message numbers separated by ':' (e.g. '1:5'), and/or individual message numbers separated by ',' (e.g. '1:5,7,10'). |
| Labels | String | True | The labels to be set to the message specified by the MessageSet property. This input must be a space-delimited list of labels. |
| OperationType | String | False | This indicates weather the specified labels should be added,removed or replace existing labels list.
使用できる値は次のとおりです。ADD, REPLACE, REMOVE デフォルト値はREPLACEです。 |
| Name | Type | Description |
| Success | String | Boolean response indicating whether or not the operation was successful. |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、Gmail のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
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 | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Inbox テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Inbox'
| 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 などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、SendMailMessage ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SendMailMessage' 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 | パラメータのインデックス。 |
主キーおよび外部キーについて説明します。
次のクエリは、Inbox テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Inbox'
| 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:gmail: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 | Gmail に接続する際に使用する認証の種類。 |
| Schema | REST（デフォルト）またはIMAP のどちらのGmail API を利用するかを指定するために使用します。 |
| User | 認証で使用されるGmail ユーザーアカウント。 |
| Password | ユーザーの認証で使用されるパスワード。 |
| プロパティ | 説明 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| Scope | When this is set, the provider will request an access token with this specific scope. |
| プロパティ | 説明 |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
| OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクト。 |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
| プロパティ | 説明 |
| Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
| プロパティ | 説明 |
| BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| プロパティ | 説明 |
| IncludeMessage | メッセージbody 内容を含めるかどうか。 |
| IsHTML | MessageBody がHTML かプレーンテキストかを決定します。 |
| KeepAlive | この値がtrue の場合は、IMAP 接続が維持されます。 |
| ListMailboxes | すべてのメールボックスをリストするか、サブスクライブされたIMAP メールボックスのみをリストするか。 |
| MaxItems | 返すアイテムの最大数。 |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| MessageCharset | Specifies the session character set for decoding character data transferred from the IMAP server. |
| PeekMode | True の場合、IMAP に送信されるすべてのFETCH コマンドにPEEK が追加されます。/Seen フラグを設定しないようにするために使用されます。 |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| QueryFullDetails | メッセージの完全な詳細を含めるかどうかを決定します。 |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UIDMode | True に設定された場合、デフォルトのテンポラリーId ではなく、パーマネントメッセージId が使われます。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | Gmail に接続する際に使用する認証の種類。 |
| Schema | REST（デフォルト）またはIMAP のどちらのGmail API を利用するかを指定するために使用します。 |
| User | 認証で使用されるGmail ユーザーアカウント。 |
| Password | ユーザーの認証で使用されるパスワード。 |
Gmail に接続する際に使用する認証の種類。
string
"Auto"
REST（デフォルト）またはIMAP のどちらのGmail API を利用するかを指定するために使用します。
string
"REST"
REST（デフォルト）またはIMAP のどちらのGmail API を利用するかを指定するために使用します。Basic 認証はIMAP スキーマでのみサポートされていることに注意してください。
認証で使用されるGmail ユーザーアカウント。
string
""
このフィールドは、Password とともに、Gmail サーバーに対して認証をするために使われます。
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
| OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
| Scope | When this is set, the provider will request an access token with this specific scope. |
OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。
string
""
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId 値、およびクライアントシークレットOAuthClientSecret が提供されます。
OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。
string
""
OAuth アプリケーションの登録の一環として、コンシューマキーとも呼ばれるOAuthClientId が提供されます。また、コンシューマーシークレットと呼ばれるクライアントシークレットも提供されます。クライアントシークレットをOAuthClientSecret プロパティに設定します。
When this is set, the provider will request an access token with this specific scope.
string
""
初期アクセストークンとリフレッシュトークンを取得するスコープを指定します。
Set this property to retrieve a scoped token with specific privileges.
このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthJWTCert | JWT 証明書のストア。 |
| OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
| OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
| OAuthJWTCertSubject | OAuth JWT 証明書のサブジェクト。 |
JWT 証明書のストア。
string
""
クライアント証明書のための証明書ストア名。
OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。
OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。
証明書ストアの指定はプラットフォームに依存します。
Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。
| MY | 個人証明書と関連付けられた秘密キーを格納している証明書ストア。 |
| CA | 証明機関の証明書。 |
| ROOT | ルート証明書。 |
| SPC | ソフトウェア発行元証明書。 |
Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。
証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。
JWT 証明書を格納するキーストアの種類。
string
"GOOGLEJSONBLOB"
このプロパティには次の値の一つを設定できます。
| USER | Windows の場合、現在のユーザーにより所有された証明書ストアであることを指定します。 Note：この種類はJava では利用できません。 |
| MACHINE | Windows の場合、この証明書ストアがシステムストアであることを指定します。 Note：この種類はJava では利用できません。 |
| PFXFILE | この証明書ストアは、証明書を含むPFX（PKCS12）ファイルの名前です。 |
| PFXBLOB | この証明書ストアは、PFX（PKCS12）形式の証明書ストアを表すBase-64でエンコードされた文字列です。 |
| JKSFILE | この証明書ストアは、証明書を含むJava key store（JKS）ファイルの名前です。 Note：この種類はJava のみで利用できます。 |
| JKSBLOB | この証明書ストアは、Java key store（JKS）形式の証明書ストアを表すBase-64でエンコードされた文字列です。 Note：この種類はJava のみで利用できます。 |
| PEMKEY_FILE | この証明書ストアは、秘密キーと任意の証明書を含むPEM でエンコードされたファイルの名前です。 |
| PEMKEY_BLOB | この証明書ストアは、秘密キーと任意の証明書を含むBase-64でエンコードされた文字列です。 |
| PUBLIC_KEY_FILE | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むファイルの名前です。 |
| PUBLIC_KEY_BLOB | この証明書ストアは、PEM またはDER でエンコードされた公開キーの証明書を含むBase-64でエンコードされた文字列です。 |
| SSHPUBLIC_KEY_FILE | この証明書ストアは、SSH 公開キーを含むファイルの名前です。 |
| SSHPUBLIC_KEY_BLOB | この証明書ストアは、SSH 公開キーを含むBase-64でエンコードされた文字列です。 |
| P7BFILE | この証明書ストアは、証明書を含むPKCS7 ファイルの名前です。 |
| PPKFILE | この証明書ストアは、PuTTY 秘密キー（PPK）を含むファイルの名前です。 |
| XMLFILE | この証明書ストアは、XML 形式の証明書を含むファイルの名前です。 |
| XMLBLOB | この証明書ストアは、XML 形式の証明書を含む文字列の名前です。 |
| GOOGLEJSON | この証明書ストアは、サービスアカウント情報を含むJSON ファイルの名前です。Google サービスに接続する場合にのみ有効です。 |
| GOOGLEJSONBLOB | この証明書ストアは、サービスアカウントのJSON を含む文字列です。Google サービスに接続する場合にのみ有効です。 |
OAuth JWT 証明書のパスワード。
string
""
証明書ストアでパスワードが必要である場合、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。
GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーは暗号化されていません。
OAuth JWT 証明書のサブジェクト。
string
"*"
証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。
完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。
それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。
"*" に設定すると、証明書ストアの1番目の証明書が選択されます。
証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。
| フィールド | 説明 |
| CN | 共通名。一般的には、www.server.com のようなホスト名です。 |
| O | 法人名 |
| OU | 法人の部署名 |
| L | 法人の住所（市町村名） |
| S | 法人の住所（都道府県） |
| C | 国名 |
| E | Eメールアドレス |
フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。
このセクションでは、本プロバイダーの接続文字列で設定可能な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 プロパティの全リストを提供します。
| プロパティ | 説明 |
| IncludeMessage | メッセージbody 内容を含めるかどうか。 |
| IsHTML | MessageBody がHTML かプレーンテキストかを決定します。 |
| KeepAlive | この値がtrue の場合は、IMAP 接続が維持されます。 |
| ListMailboxes | すべてのメールボックスをリストするか、サブスクライブされたIMAP メールボックスのみをリストするか。 |
| MaxItems | 返すアイテムの最大数。 |
| MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
| MessageCharset | Specifies the session character set for decoding character data transferred from the IMAP server. |
| PeekMode | True の場合、IMAP に送信されるすべてのFETCH コマンドにPEEK が追加されます。/Seen フラグを設定しないようにするために使用されます。 |
| PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
| QueryFullDetails | メッセージの完全な詳細を含めるかどうかを決定します。 |
| Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
| UIDMode | True に設定された場合、デフォルトのテンポラリーId ではなく、パーマネントメッセージId が使われます。 |
メッセージbody 内容を含めるかどうか。
bool
false
メッセージbody 内容を含めるかどうか。
MessageBody がHTML かプレーンテキストかを決定します。
bool
true
MessageBody がHTML かプレーンテキストかを決定します。
この値がtrue の場合は、IMAP 接続が維持されます。
bool
true
Cloud は、KeepAlive 設定を使用して、IMAP 接続を維持するかどうかを決定します。メールサーバーに対して複数のクエリを実行する場合は、接続を維持することをお勧めします。
すべてのメールボックスをリストするか、サブスクライブされたIMAP メールボックスのみをリストするか。
string
"All"
すべてのメールボックスをリストするか、サブスクライブされたIMAP メールボックスのみをリストするか。
返すアイテムの最大数。
string
"100"
返すアイテムの最大数。
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
int
-1
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
Specifies the session character set for decoding character data transferred from the IMAP server.
string
"UTF-8"
Specifies the session character set for decoding character data transferred from the IMAP server. The default value is UTF-8. Set it to 'None' to leave the charset unspecified. This can resolve some timeout errors that can be caused by an incorrect charset configuration.
True の場合、IMAP に送信されるすべてのFETCH コマンドにPEEK が追加されます。/Seen フラグを設定しないようにするために使用されます。
bool
false
True の場合、IMAP に送信されるすべてのFETCH コマンドにPEEK が追加されます。/Seen フラグを設定しないようにするために使用されます。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
string
""
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
メッセージの完全な詳細を含めるかどうかを決定します。
bool
true
メッセージの完全な詳細を含めるかどうかを決定します。REST スキーマでのみ利用可能です。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
int
60
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。
True に設定された場合、デフォルトのテンポラリーId ではなく、パーマネントメッセージId が使われます。
bool
false
UIDMode のデフォルト値はFalse です。