CData Sync App は、Streak データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Streak コネクタはCData Sync アプリケーションから使用可能で、Streak からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App はStreak API を使用してStreak への双方向アクセスを実現します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
Streak への接続には、BASIC 認証標準を使います。 BASIC Auth では認証するユーザーにブラウザでStreak との通信を要求します。下記で説明するとおり、Sync App はさまざまな方法でこれをサポートします。
(BASIC)認証キーは、Streak アカウント用に作成する必要があります。
このセクションでは、Streak Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、Streak にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI オブジェクトを示し、Streak API へのSQL の実行について詳しく説明します。
ビュー では、利用可能なビューを説明します。ビューは、連絡先およびミーティングを静的にモデル化するように定義されています。
ストアドプロシージャ は、Streak のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、BOX に連絡先を追加するなど、Streak の操作を実行できます。
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
Boxes | This call lets you get all boxes contained in the specified pipeline. |
BoxesContacts | This call lists the contacts defined in a box. |
BoxesOrganizations | This call lists the organizations defined in a box. |
Comments | Retrieve comments. |
Contacts | Retrieve contacts. |
EmailFilters | Retrieves an array of email filters within a box. |
Files | Retrieve Streak files from a specific box. |
Meetings | Retrieve mettings for a specific box. |
Newsfeeds | This endpoint will give you historical changes for boxes and pipelines. It is limited to the 50 most recent events. |
Organizations | Retrieve organizations from Streak. |
Pipelines | Gets list of pipelines and also retrive a single pipeline |
Snippets | This call lets you get all the snippets for a user, also you can get a single snippet |
Stages | This call gives you a specific stage defined in a pipeline. |
Tasks | Retrieves tasks from Streak. |
TeamMembers | Retrieve members of teams. Users can be on 0 or more teams. |
Teams | Retrieve teams from Streak. Users can be on 0 or more teams. |
Threads | Retrieve threads from Streak. |
Users | Retrieve users details. |
Webhooks | Retrieves webhoods from Streak. |
This call lets you get all boxes contained in the specified pipeline.
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available columns for Boxes are BoxKey and PipelineKey. For example:
SELECT * FROM Boxes WHERE PipelineKey = 'agxzfm1haWxmb29nYWVyMAsSDE9yZ2FuabphdGlvbiIJY2RhdGEuY29tDAsSCFdvcmtmbG93GICArJ_i0_EIDA' SELECT * FROM Boxes WHERE BoxKey = 'agxzfm1haWxmb29nYWVyLAsSDE9yZ2FuaXphdabvbiIJY2RhdGEuY29tDAsSBENhc2UYgICs7-O4mwsM'
Name | Type | References | Description |
BoxKey [KEY] | String | Key of Box | |
LastSavedTimestamp | Timestamp | Time stamp saved last in ePoch format | |
PipelineKey | String |
Pipelines.PipelineKey | Key of the pipeline the box is in |
CreatorKey | String |
Users.UserKey | Key of a creator |
CreationTimestamp | Timestamp | Time stamp when box was created | |
LastUpdatedTimestamp | Timestamp | Timestamp of the last time the box was updated | |
LastStageChangeTimestamp | Timestamp | Time stamp when box was updated | |
TotalNumberOfEmails | Integer | Count of total number of emails | |
TotalNumberOfSentEmails | Integer | Count of total number of emails sent | |
TotalNumberOfReceivedEmails | Integer | Count of total number of emails received | |
Name | String | Name of the box found | |
Notes | String | Sample notes for description of box | |
AssignedToSharingEntries | String | Details of number of user assigned to | |
CreatorSharingEntry | String | Details of number of user created | |
FollowerSharingEntries | String | Details of number of user followers | |
FollowerKeys | String | Key of the followers of this box | |
LinkedBoxKeys | String | Any key linked to the particular box | |
EmailAddressesAutoExtracted | String | List of email which can be auto extracted | |
EmailAddressesBlacklist | String | List of email address which is blacklist by user | |
EmailAddresses | String | List of email addresses | |
TaskCompleteCount | Integer | Count of task which is completed | |
TaskIncompleteCount | Integer | Count of task which is incompleted | |
TaskOverdueCount | Integer | Count of task which is overdue | |
TaskAssigneeKeySet | String | List of key set the task is assigned to | |
OverdueTaskAssigneeKeySet | String | List of key set the overdue task is assigned to | |
IncompleteTaskAssigneeKeySet | String | List of key set the incomplete task is assigned to | |
TaskAssigneeSharingEntrySet | String | Set of users whom task is assigned to | |
OverdueTaskAssigneeSharingEntrySet | String | Set of users whom task is assigned to but overdue | |
IncompleteTaskAssigneeSharingEntrySet | String | Set of users whom task is assigned to but is incomplete | |
TaskTotal | Integer | List of total number of tasks | |
CallLogCount | Integer | List of call log count | |
MeetingNotesCount | Integer | List of meeting notes | |
TotalCallLogDuration | Integer | List of total call log duration | |
TotalMeetingNotesDuration | Integer | Lost of total meeting duration notes | |
FollowerCount | Integer | Count of number of followers | |
CommentCount | Integer | Count of number of comments | |
GmailThreadCount | Integer | Count of number of gmail threads | |
FileCount | Integer | Count of number of files | |
Fields | String | Number of fields | |
Freshness | Double | Amount of freshness | |
StageKey | String |
Stages.StageKey | A unique identifier for the containing folder. Set this in the filter to retreive only files under the specified parent folder. |
This call lists the contacts defined in a box.
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for BoxesContacts is PipelineKey. For example:
SELECT * FROM BoxesContacts WHERE PipelineKey = 'agxzfm1haWxmb29nYWVyMAsSDE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSCFdvcmtmbG93GICArJ_i0_EIDA'
Name | Type | References | Description |
BoxKey | String |
Boxes.BoxKey | Key of the box the contact is in. |
ContactKey | String |
Contacts.ContactKey | Key of the Contact. |
IsAutoboxed | String | If the organization is auto boxed. | |
IsStarred | String | If the contact is starred or not. |
This call lists the organizations defined in a box.
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for BoxesOrganizations is PipelineKey. For example:
SELECT * FROM BoxesOrganizations WHERE PipelineKey = 'agxzfm1haWxmb29nYWVyMAsSDE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSCFdvcmtmbG93GICArJ_i0_EIDA';
Name | Type | References | Description |
BoxKey | String |
Boxes.BoxKey | Key of the box the organization is in. |
OrganizationKey | String |
Organizations.OrganizationKey | Key of the Organization. |
IsAutoboxed | String | If the organization is auto boxed. | |
IsStarred | Boolean | If the organization is starred. |
Retrieve comments.
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for Comments is CommentKey. For example:
SELECT * FROM Comments WHERE CommentKey = 'agxzfm1haWxmb29nYWVyLabSDE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSB0NvbW1lbnQYgIDsyJ_29gsM'
Name | Type | References | Description |
CommentKey [KEY] | String | Key of the comment. | |
BoxKey | String |
Boxes.BoxKey | Box associated with the comment. |
PipelineKey | String |
Pipelines.PipelineKey | Pipeline associated with the comment. |
CreatorKey | String |
Users.UserKey | User that created the comment. |
NewsfeedEntryKey | String |
Newsfeeds.NewsfeedEntryKey | News feed entry key for this comment. |
Timestamp | Timestamp | When this comment was created. | |
Message | String | The value of the comment. | |
LastSavedTimestamp | Timestamp | When the comment was last saved. |
Retrieve contacts.
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for Contacts is ContactKey. For example:
SELECT * FROM Contacts WHERE ContactKey = 'VGVhbUNvbabhY3Qsfn5zdHJlYWtsb25naWR-fjYyMzUwNzEzOTk1MjY0MDA'
Name | Type | References | Description |
ContactKey [KEY] | String |
BoxesContacts.ContactKey | Key of the contact. |
TeamKey | String |
Teams.TeamKey | Key of the team. |
GivenName | String | The contact's name. | |
FamilyName | String | The family name of the contact. | |
Other | String | Extra description for the contact. | |
Title | String | Title of contact. | |
EmailAddresses | String | List of email addresses for the contact. | |
PhoneNumbers | String | List of email phone numbers for the contact. | |
Addresses | String | List of addresses for the contact. | |
TwitterHandle | String | Link to the contact's twitter profile. | |
FacebookHandle | String | Link to the contact's facebook profile. | |
LinkedinHandle | String | Link to the contact's twitter profile. | |
PhotoUrl | String | URL to the profile picture of the contact. | |
OrgLinksKey | String | Organizations the contact is assocated with. | |
LastEnrichmentTimestamp | Datetime | When the contact was last enriched. | |
LastSavedUserKey | String |
Users.UserKey | User who last saved the contact record. |
CreatorKey | String |
Users.UserKey | Creator of the contact record. |
CreationDate | Datetime | Creation date for the contact record. | |
VersionTimestamp | Datetime | Datetime associated with this version of the contact. | |
LastSavedTimestamp | Datetime | When the contact record was last saved. |
Retrieves an array of email filters within a box.
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for EmailFilters is BoxKey. For example:
SELECT * FROM EmailFilters WHERE BoxKey = 'agxzfm1haWxmb29nYWabLAsSDE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSBENhc2UYgICs7-O4mwsM'
Name | Type | References | Description |
EmailFilterKey [KEY] | String | Key of the email filter. | |
CreatorKey | String |
Users.UserKey | Key of the creator of the email filter. |
BoxKey | String |
Boxes.BoxKey | Box key. |
Type | String | Type of email filter. | |
Value | String | Value of email filter. | |
Domain | String | The domain name. | |
CreationTimestamp | Timestamp | When the email filter was created. | |
LastSavedTimestamp | Timestamp | When the email filter was last saved. |
Retrieve Streak files from a specific box.
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available columns for Files are FileKey and BoxKey. For example:
SELECT * FROM Files WHERE FileKey = 'agxzfm1haWxmb29nYWVyLAsabE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSBEZpbGUYgIDs8PiumAkM' SELECT * FROM Files WHERE BoxKey = 'agxzfm1haWxmb29nYWVyLAsSDE9yZ2FabXphdGlvbiIJY2RhdGEuY29tDAsSBENhc2UYgICs7-O4mwsM'
Name | Type | References | Description |
FileKey [KEY] | String | Key of the file. | |
FileType | String | Type will be either GMAIL_API or DRIVE. GMAIL_API means the information was scraped from email attachments in a box. DRIVE means the user added a drive file to the box directly. | |
FileOwner | String |
Users.UserKey | Each file comes from a particular email that was added to a box. This property is the key of the user that added the email to the box. |
BoxKey | String |
Boxes.BoxKey | Key of the box. |
CreationTimestamp | Timestamp | When the file was created. | |
LastUpdatedTimestamp | Timestamp | When the file was last updated. | |
Size | String | The size of the file in bytes. | |
MimeType | String | The mime type of the file. | |
FileName | String | The filename with the extension. | |
MainFileName | String | The filename without the extension. | |
DriveUrl | String | Google drive URL of attachment. | |
DriveFileId | String | Google drive File Id of attachment. | |
DriveIconUrl | String | Google drive URL of Icon of attachment. | |
DriveOwnerId | String | Google drive Owner Id of attachment. | |
DriveBoxKey | String | Google drive Box key of attachment. | |
IsCurrentUserOwnerInDrive | Boolean | Whether the user is the owner of the file in google drive. | |
LastSavedTimestamp | Timestamp | When the file was last saved. |
Retrieve mettings for a specific box.
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for Meetings is BoxKey. For example:
SELECT * FROM Meetings WHERE BoxKey = 'agxzfm1haWxmb29nYWVyLAsSDE9yZ2FuaXabdGlvbiIJY2RhdGEuY29tDAsSBENhc2UYgICsv6fs-ggM'
Name | Type | References | Description |
MeetingKey [KEY] | String | Key of the meeting. | |
MeetingType | String | The type of meeting. This is either CALL_LOG or MEETING_NOTES. | |
BoxKey | String |
Boxes.BoxKey | Key of the box. |
PipelineKey | String |
Pipelines.PipelineKey | Key of the pipeline. |
OrgKey | String | It is a unique encrypted code that identifies the team that you are on. | |
CreatorKey | String |
Users.UserKey | The key of the user who created the meeting. When creating from the API, this will be the userkey of the user whose API key is being used. |
CreationDate | Timestamp | When the meeting was created. | |
StartTimestamp | Timestamp | When the meeting starts. | |
Duration | Integer | The duration of the meeting in milliseconds. | |
Notes | String | The unicode content of the meeting note or call log. | |
LastSavedTimestamp | Timestamp | When the meeting was last updated. |
This endpoint will give you historical changes for boxes and pipelines. It is limited to the 50 most recent events.
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available columns for Newsfeeds are BoxKey and PipelineKey. For example:
SELECT * FROM Newsfeeds WHERE BoxKey = 'agxzfm1haWxmb29nYWVyLAsSDE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSBENhc2UYgICsv6fs-ggM' AND detailLevel = 'ALL' SELECT * FROM Newsfeeds WHERE PipelineKey = 'agxzfm1haWxmb29nYWabMAsSDE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSCFdvcmtmbG93GICArJ_i0_EIDA'
Name | Type | References | Description |
NewsfeedItemKey [KEY] | String | The news feed item key. | |
NewsfeedEntryKey | String | The news feed entry key. | |
CreatorKey | String |
Users.UserKey | The key of the user that created this newsfeed item. |
Timestamp | Timestamp | When this event occurred. | |
NewsfeedEntryScope | String | What this event applies to - either a BOX or PIPELINE. | |
NewsfeedEntryOperation | String | Whether this event refers to a CREATE, UPDATE, or DELETE. | |
NewsfeedEntrySpecific | String | What specifically happened to cause this event. | |
SpecificVariablesAssignedTo | String | Member assigned to the particular newsfeed. | |
SpecificVariablesStoryAuthorDisplayName | String | Display name of the story author. | |
SpecificVariablesBoxName | String | Name of the box. | |
SpecificVariablesOldStageName | String | Name of an old stage. | |
SpecificVariablesLastStageChangeTimestamp | Timestamp | Last time the stage was chagned. | |
SpecificVariablesStageName | String | Name of the stage. | |
SpecificVariablesStageKey | String |
Stages.StageKey | Key of the stage. |
SpecificVariablesPipelineName | String | Name of the pipeline. | |
SpecificVariablesOldStageKey | String |
Stages.StageKey | Key of the old stage. |
BoxKey | String |
Boxes.BoxKey | Key of the box. |
PipelineKey | String |
Pipelines.PipelineKey | Key of the pipeline. |
Moved | Boolean | Whether the news feed is moved or not. | |
StoryTextGlobal | String | Global story text used for the news feed. | |
StoryTextPipeline | String | Pipeline story text used for the news feed. | |
StoryTextBox | String | Box story text used for the news feed. | |
UserText | String | A user entered description. | |
ExpandedUserText | String | Details like full name and email id of the user. | |
DetailText | String | A more detailed description. | |
UserImageUrl | String | URL of the user profile photo. | |
CollapsedEntries | String | List of collapsed entries. | |
LastSavedTimestamp | Timestamp | When the item was last saved. | |
detailLevel | String | This is similar to the specifics parameter but uses a predetermined set of specifics to filter on. The possible values for this parameter are ALL or CONDENSED. The CONDENSED value limits the results to only certain important specific parameters determined by Streak.
使用できる値は次のとおりです。ALL, CONDENSED |
Retrieve organizations from Streak.
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for Organizations is OrganizationKey. For example:
SELECT * FROM Organizations WHERE OrganizationKey = 'VGVhbU9yZ2FuaXphdGlvbix-fnN0cmVab2xvbmdpZH5-NDkyMjAwNDI3MDE1MzcyOA'
Name | Type | References | Description |
OrganizationKey [KEY] | String |
BoxesOrganizations.OrganizationKey | Key of the organization. |
TeamKey | String |
Teams.TeamKey | Key of the team. |
Name | String | Full name of the organization. | |
Other | String | Extra information about the organization. | |
Domains | String | List of domains. | |
NormalizedDomains | String | List of domains normalized. | |
Industry | String | The industry of the organization. | |
PhoneNumbers | String | List of phone numbers. | |
Addresses | String | List of addresses. | |
EmployeeCount | String | Number of employees. | |
LogoURL | String | The logo URL. | |
TwitterHandle | String | The Twitter URL. | |
FacebookHandle | String | The Facebook URL. | |
LinkedinHandle | String | Linked-in Handle URL. | |
LastEnrichmentTimestamp | Timestamp | When the organizations was enriched. | |
ContactLinks | String | List of contact links. | |
LastSavedUserKey | String |
Users.UserKey | Key of the user who last modified the organization. |
CreatorKey | String |
Users.UserKey | Key of the user who created the organization. |
CreationDate | Timestamp | When the organization was created. | |
VersionTimestamp | Timestamp | Version of the time stamp. | |
LastSavedTimestamp | Timestamp | When the organization was last saved. |
Gets list of pipelines and also retrive a single pipeline
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for Pipelines is PipelineKey. For example:
SELECT * FROM Pipelines WHERE PipelineKey = 'agxzfm1haWxmb29nYWVyMAsSDE9yZ2abaXphdGlvbiIJY2RhdGEuY29tDAsSCFdvcmtmbG93GICArJ_i0_EIDA'
Name | Type | References | Description |
PipelineKey [KEY] | String | Key of the pipeline. | |
TeamKey | String |
Teams.TeamKey | Key of the team. |
CreatorKey | String |
Users.UserKey | The user key of the user that created the pipeline. |
Name | String | The name of this pipeline. | |
OrgWide | Boolean | Whether the organization is wide. | |
SharingRestrictedToOrg | Boolean | Whether the sharing is restricted to organization only or not. | |
TeamWide | Boolean | Whether this pipeline is shared with all users in the organization (same domain in email address). | |
SharingRestrictedToTeam | Boolean | Whether sharing is restricted to your team only or not. | |
StageOrder | String | Editable array which allows you to reorder the stages. This modifies the order of the stages that appear in the web UI. | |
StageColorTheme | String | Color theme of the stage. | |
CreationTimestamp | Timestamp | When the pipeline was created. | |
LastUpdatedTimestamp | Timestamp | When the pipeline was last updated. | |
CustomPermissionSets | String | Custom permission sets. | |
DefaultPermissionSetName | String | Default permission set name. | |
AclEntries | String | An array of ACL objects (with properties: fullName, email, isOwner, image) which determines a list of users who have access to this pipeline. | |
CreationSourceType | String | Source type used to create the pipeline. | |
BoxCountHint | Integer | Box count hint. | |
BoxCount | Integer | Number of boxes for this pipeline. | |
LastSavedTimestamp | Timestamp | When the pipeline was last saved. |
This call lets you get all the snippets for a user, also you can get a single snippet
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for Snippets is SnippetKey. For example:
SELECT * FROM Snippets WHERE SnippetKey = 'agxzfm1haWxmb29nYWVyLwsSDE9yZ2FuaXphdGlvbgvJY2RhdGEuY29tDAsSB1NuaXBwZXQYgIDsmPfxwAsM'
Name | Type | References | Description |
SnippetKey [KEY] | String | Key of the snippet. | |
UserKey | String |
Users.UserKey | The key of the user that created the snippet. |
CreationDate | Timestamp | The date and time the snippet was created. | |
PipelineKey | String |
Pipelines.PipelineKey | Key of the pipeline. |
PartOfPipeline | Boolean | Whether this snippet is part of a pipeline or not. | |
SnippetText | String | The text of the snippet. | |
SnippetName | String | The name of the snippet. | |
SnippetKeyShortcut | String | Shortcut of the snippet key. | |
Subject | String | Subject of the snippets. | |
SnippetType | String | The type of the snippet, can be TEXT or HTML. | |
LastSavedTimestamp | Timestamp | When the snippet was last saved. |
This call gives you a specific stage defined in a pipeline.
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available columns for Stages are PipelineKey and StageKey. For example:
SELECT * FROM Stages WHERE PipelineKey = 'agxzfm1haWxmb29nYWVyMAsSab9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSCFdvcmtmbG93GICArJ_i0_EIDA' SELECT * FROM Stages WHERE PipelineKey = 'agxzfm1haWxmb29nYWVyMAsSDE9yZ2FuaXphdGlvbiIJabRhdGEuY29tDAsSCFdvcmtmbG93GICArJ_i0_EIDA' AND StageKey = '5001'
Name | Type | References | Description |
StageKey [KEY] | String | Key of the stage. | |
PipelineKey | String |
Pipelines.PipelineKey | The key of the pipeline. |
Name | String | Name of the stage. | |
ForegroundColor | String | Foreground color of the stage. | |
BackgroundColor | String | Background color of the stage. | |
BoxCount | Integer | Number of boxes this stage is applied to. | |
IsColorFromTheme | Boolean | Whether the color is from a theme. |
Retrieves tasks from Streak.
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available columns for Tasks are TaskKey and BoxKey. For example:
SELECT * FROM Tasks WHERE TaskKey = 'agxzfm1haWxmb29nYWVabAsSDE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSBFRhc2sYgIDs0NySvQsM' SELECT * FROM Tasks WHERE BoxKey = 'agxzfm1haWxmb29nYWVyLAsSDE9yZ2FuaXphablvbiIJY2RhdGEuY29tDAsSBENhc2UYgICs7-O4mwsM'
Name | Type | References | Description |
TaskKey [KEY] | String | Key of the task. | |
BoxKey | String |
Boxes.BoxKey | The box the task is in. |
PipelineKey | String |
Pipelines.PipelineKey | The pipeline the task is in. |
CreatorKey | String |
Users.UserKey | The user who created the task. |
CreationDate | Timestamp | When the task was created. | |
LastStatusChangeDate | Timestamp | When the status last changed. | |
DueDate | Timestamp | When the task is due and a reminder is sent. | |
SortOrder | String | Sort order of the task. | |
Text | String | The text of a task. | |
Status | String | Whether the task is DONE or NOT_DONE. | |
ReminderStatus | String | Gets the status of the reminder if this task has to be done. Can be: NONE, SCHEDULED, REMINDED or ERROR_ON_REMINDER. | |
AssignedToSharingEntries | String | Who the task is assigned to. | |
CreatorSharingEntry | String | User who created the sharing entries. | |
LastSavedTimestamp | Timestamp | When the task was last saved. |
Retrieve members of teams. Users can be on 0 or more teams.
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for TeamMembers is TeamKey. For example:
SELECT * FROM TeamMembers WHERE TeamKey = 'agxzfm1haWxmb29nYWVabQsSBFRlYW0YgICsv_OxuAoM'
Name | Type | References | Description |
TeamKey [KEY] | String |
Teams.TeamKey | Key of the team. |
UserKey [KEY] | String |
Users.UserKey | Key of the user on the team. |
DisplayName | String | Display name of the team member. | |
FullName | String | Full name of the team member. | |
Role | String | Role of the team member. | |
InviteDate | Timestamp | When the member was invited. | |
InviteStatus | String | Status of the invitation. | |
OrgKey | String | It is a unique encrypted code that identifies the team that you are on. | |
String | Email address for the team member. | ||
Image | String | Url to an image of the member. |
Retrieve teams from Streak. Users can be on 0 or more teams.
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for Teams is TeamKey. For example:
SELECT * FROM Teams WHERE TeamKey = 'agxzfm1haWxmb29nYWVyEabSBFRlYW0YgICsv_OxuAoM'
Name | Type | References | Description |
TeamKey [KEY] | String | Key of the team. | |
Name | String | Name of the team. | |
CreationDate | Timestamp | When the team was created. | |
Creator | String | The creator of the team. | |
PlanInstanceKey | String | Key of the instance plan. | |
PlanInstance | String | Name of the instance plan. | |
SharingRestrictedToTeam | Boolean | Whether sharing is restricted to this team or not. | |
LastSavedTimestamp | Timestamp | When the team record was last saved. |
Retrieve threads from Streak.
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available columns for Threads are BoxKey and ThreadKey. For example:
SELECT * FROM Threads WHERE BoxKey = 'agxzfm1haWxmb29nYWVyLAsSDE9ab2FuaXphdGlvbiIJY2RhdGEuY29tDAsSBENhc2UYgICs7-O4mwsM' SELECT * FROM Threads WHERE ThreadKey = 'agxzfm1haWxab29nYWVyMwsSDE9yZ2FuaXphdGlvbiIJY2RhdGEuY29tDAsSC0dtYWlsVGhyZWFkGICAnP6JrfsJDA'
Name | Type | References | Description |
ThreadKey [KEY] | String | Key of the thread. | |
BoxKey | String |
Boxes.BoxKey | Key of the box the thread is in. |
CreatorKey | String |
Users.UserKey | Creator of the thread. |
PipelineKey | String |
Pipelines.PipelineKey | Pipeline the thread is in. |
CreationTimestamp | Timestamp | When the thread was created. | |
LastUpdatedTimestamp | Timestamp | When the thread was updated. | |
LastEmailTimestamp | Timestamp | Datetime of the last email in the thread. | |
LastEmailFrom | String | Email address of last email. | |
NumberOfEmails | Integer | List of number of emails. | |
SenderEmailSendTimestampPairs | String | Whether the sender email can send timestamp pairs or not. | |
MessageSentTimestamps | String | When the message was sent. | |
Subject | String | The subject of the first email in the thread. | |
Names | String | The senders and recipients on the gmail thread. | |
EmailAddresses | String | The senders and recipients on the gmail thread. | |
ThreadGmailId | String | Gmail's key for the thread. | |
FileKeys | String | List of file keys, such as attachments in the thread. | |
GmailThreadKey | String | Key of Gmail thread. | |
LastSavedTimestamp | Timestamp | When the thread was saved last. |
Retrieve users details.
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available column for Users is UserKey. For example:
SELECT * FROM Users WHERE UserKey = 'agxzfm1haWxmb29nYWVyLAsSDE9yZ2abaXphdGlvbiIJY2RhdGEuY29tDAsSBFVzZXIYgICs35ruuwkM'
Name | Type | References | Description |
UserKey [KEY] | String | Key of a user. | |
String | The email address of the the user. | ||
OrgKey | String | It is a unique encrypted code that identifies the team that you are on. | |
CreationTimestamp | Timestamp | When the user was created. | |
LastUpdatedTimestamp | Timestamp | When the user was last updated. | |
LastSeenTimestamp | Timestamp | When the user last logged into Streak. | |
TimezoneId | String | Id of current time zone. | |
UsedPlatforms | String | List of platforms that are being used. | |
GoogleProfileId | String | ID of the user's google profile. | |
GoogleProfilePhotoUrl | String | Profile Photo URL on the user's google profile. | |
GoogleProfileLink | String | Link to the user's google profile. | |
GoogleProfileFullName | String | Full Name on the user's google profile. | |
GoogleProfileFirstName | String | First Name on the user's google profile. | |
GoogleProfileLastName | String | Last Name on the user's google profile. | |
GoogleProfileGender | String | Gender on the user's google profile. | |
GoogleProfileLocale | String | Locale on the user's google profile. | |
GoogleAnalyticsClientId | String | Analytics Client Id on the user's google profile. | |
IsOauthComplete | Boolean | Whether the user has completed the OAuth process. Useful to determine whether they can successfully share emails. | |
DisplayName | String | A display friendly name, usually the users full name if it exists in their profile. | |
Experiments | String | List of experiments. | |
TourId | String | The tour id. | |
UserSettingsKey | String | Key to the user's settings information. | |
LastTrialLength | Integer | Length of a last trial. | |
OnTrialWithoutCreditCard | Boolean | Whether the trial is without credit card or not. | |
CanceledTrial | Boolean | Whether the trial is cancelled or not. | |
FirstOauthTimestamp | Timestamp | When the first OAuth connection was done. | |
WantsTaskDigestEmail | Boolean | Whether task digest email is required or not. | |
LastSavedTimestamp | Timestamp | When the user was last saved. |
Retrieves webhoods from Streak.
Streak allows only a small subset of columns to be used in the WHERE clause of a SELECT query. These columns can typically be used with only = comparision. The available columns for Webhooks are PipelineKey, TeamKey, and WebhookKey. For example:
SELECT * FROM Webhooks WHERE PipelineKey = 'agxzfm1haWxmb29nYWVyMAsSDE9yZ2FuabphdGlvbiIJY2RhdGEuY29tDAsSCFdvcmtmbG93GICArJ_i0_EIDA' SELECT * FROM Webhooks WHERE TeamKey = 'agxzfm1haWxmb29nYWVyEQsSBFRlYW0YgICsv_OxuAoM' SELECT * FROM Webhooks WHERE WebhookKey = 'agptYIDA'
Name | Type | References | Description |
WebhookKey [KEY] | String | Key of the webhook. | |
PipelineKey | String |
Pipelines.PipelineKey | Key of the pipeline the webhook is in. |
CreationDate | Timestamp | Creation date of webhook. | |
Event | String | The type of webhook event. | |
LastSavedTimestamp | Timestamp | When the webhook was last saved. | |
TargetUrl | String | URL to POST the updated object to. | |
UserKey | String |
Users.UserKey | User key assoicated with this webhook. |
TeamKey | String |
Teams.TeamKey | Team key associated with this webhook. |
プロパティ | 説明 |
ApiKey | The required User Name of the role to use when authenticating. |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
LogModules | ログファイルに含めるコアモジュール。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
ApiKey | The required User Name of the role to use when authenticating. |
The required User Name of the role to use when authenticating.
Authenticating Provider Streak with ApiKey instead of "user"
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
タイプ | デフォルトポート | 説明 |
TUNNEL | 80 | これが設定されている場合、Sync App はStreak への接続を開き、プロキシを経由して通信が行われます。 |
SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
ALWAYS | 接続は、常にSSL 有効となります。 |
NEVER | 接続は、SSL 有効になりません。 |
TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\Streak Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
Platform | %APPDATA% |
Windows | APPDATA 環境変数の値 |
Linux | ~/.config |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM Users WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json指定されたパスは引用符で囲まれていないことに注意してください。