CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるLinkedIn へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してLinkedIn に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、LinkedIn への接続を標準化し、構成することができます。
このページでは、CData Cloud でのLinkedIn への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのLinkedIn への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してLinkedIn からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、LinkedIn に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
自社のサイトのLinkedIn Company ID を見つけるには2つの方法があります。
CompanyId は、LinkedIn データモデルエンティティのほとんどで要求されます。クエリの一部として直接指定することもできますが、使用しているクエリが簡単に変更できない場合は、グローバルに設定することもできます。
これが実行するクエリに必要かわからない場合は、テーブルやビューの説明を確認するか、カラムまたは擬似カラムとして指定されているかどうかを確認してください。
すべての認証フローで、OAuth 経由で接続するにはAuthScheme をOAuth に設定する必要があります。
以下のサブセクションでは、利用可能なOAuth フローでのLinkedIn への認証について詳しく説明します。 カスタムOAuth アプリケーションの作成についての情報と、すでに埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成 を参照してください。
LinkedIn で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。
アクセストークンの期限が切れたときは、Cloud は自動でアクセストークンをリフレッシュします。
ただし、Web 経由で接続するには、カスタムOAuth アプリケーションの作成が必要です。また、カスタムOAuth アプリケーションは、一般的に使用される3つの認証フローをすべてシームレスにサポートするため、これらの認証フロー用にカスタムOAuth アプリケーションを作成(独自のOAuth アプリケーションクレデンシャルを使用)することもできます。
カスタムOAuth アプリケーションは、次のような場合に有用です。
デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
CData Cloud は、LinkedIn API のエンティティをテーブル、ビュー、およびストアドプロシージャにモデル化します。これらはスキーマファイルに定義されています。テキストベースのシンプルな設定ファイルです。 このセクションでは、API の制限および要件について説明します。既定のSupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。
ビュー は変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。
ストアドプロシージャ は、データソースへの関数形式のインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
Comments | Query Comments data for Posts in the Organization Pages that you administer. |
CompanyDetails | Retrieve company profiles and updates. |
CompanyFollowerStatistics | Query statistics about followers for a particular company page. |
CompanyList | Lists all companies and the privileges that the user has within the organization. |
CompanyLocations | Retrieve company locations information. |
CompanyPageStatistics | Query statistics about page views for a particular company page. |
CompanyStatusUpdates | Lists update events from the LinkedIn company page. |
CompanyUpdateStatistics | Query update statistics about a company. If the TimeRange filters are not specified, the default result set is for the last 12 months. |
GeoLocation | Provides the display name for a given geo Id, or a set of geo Ids. |
Industries | Query the list of available industries in LinkedIn. |
OrganizationFollowerCount | The Organization Follower Count View provides the ability to retrieve the number of first-degree connections (followers) for the organization defined in the CompanyId connection string property. |
Profiles | Query profile information of LinkedIn members. |
Query Comments data for Posts in the Organization Pages that you administer.
Note: Requires the r_organization_social OAuth scope.
The Comments view supports filtering on the WHERE clause only for the UpdateId column and only for the = and IN operators. The = operator is fully supported server-side, whereas the IN operator is partially supported server-side and partially client-side. Refer the query examples below:
SELECT * FROM Comments WHERE UpdateId = 'urn:li:share:7155174232715386880'; SELECT * FROM Comments WHERE UpdateId IN ('urn:li:share:7155174232715386880', 'urn:li:share:7165681621608738816');
Additionally, the following query will return the data for the columns we expose in the view for each of the Posts in each Organization Page that the user administrates.
SELECT * FROM Comments;To retrieve information on Posts in you Organization Pages, you can use CompanyStatusUpdates.
Name | Type | Description |
Id [KEY] | String | The unique identifier for the comment. |
UpdateId | String | Id of the Update associated with the comment. |
Text | String | Content of the update comment. |
CreatedBy | String | The unique identifier for the person or company. |
Date | Datetime | Comment created time. |
Retrieve company profiles and updates.
Note: Requires the r_organization_admin OAuth scope.
The CompanyDetails view supports only the CompanyId column in the WHERE clause. The only supported operator for the CompanyId column is =. For example:
SELECT * FROM CompanyDetails WHERE CompanyId = '183432'
Name | Type | Description |
CompanyId [KEY] | String | The unique, internal, numeric identifier for the company in the following format urn:li:organization:{id} |
CompanyName | String | The name of the company. |
UniversalName | String | The unique string identifier for the company. |
Description | String | The company description. Limit of 500 characters. |
Specialties | String | The company specialties. |
StaffCountRange | String | The company staff count range. |
WebsiteUrl | String | The URL for the company website. |
Logo | String | The original company logo. |
SquareLogo | String | The square company logo. |
CompanyTypeName | String | The name of the company type. |
Groups | String | The groups of the company. |
Industries | String | The industries of the company. |
FoundedYear | Integer | The year the company was founded. |
EndYear | Integer | The year listed for when the company closed or was acquired by another. |
PrimaryOrganizationType | String | Type of primary organization being used in the lookup. Possible values: SCHOOL,BRAND,NONE |
VanityName | String | Entity's unique name used in URLs. |
VersionTag | String | Tag indicating version. |
Query statistics about followers for a particular company page.
Note: Requires the r_organization_admin OAuth scope.
The CompanyFollowerStatistics view supports only the CompanyId column in the WHERE clause. The supported operator for the CompanyId column is =. For example:
SELECT * FROM CompanyFollowerStatistics WHERE CompanyId = '183432'
The behavior of TimeGranularity in a query depends on what other inputs are specified.
Inputs specified | Result |
None | The driver returns all data from the time the company page was created until the present time, in one record. |
TimeRangeStart only (no TimeRangeEnd or TimeGranularity) | The driver returns all data from the time specified in TimeRangeStart until the present time, in one record. |
TimeRangeStart and TimeRangeEnd (no TimeRangeGranularity) | The driver returns all data from the time specified in TimeRangeStart until the time specified in TimeRangeEnd, in one record. If the value specified in TimeRangeStart is older than the time when the page was created, it retrieves all data from the time the page was created to the time specified in TimeRangeEnd. |
TimeRangeEnd only (no TimeRangeStart or TimeGranularity) | The driver returns all data from the time the company page was created, until the time specified in TimeRangeEnd, in one record. |
All | The driver breaks down the data into multiple records with different time intervals: one record for every day/month beginning from TimeRangeStart until TimeRangeEnd, depending on the value specified in TimeGranularity. |
Name | Type | Description |
CompanyId | String | Id of the Company associated with the follow statistics in the following format urn:li:organization:{id}. |
Category | String | The category of the followers. |
Type | String | Type of the category. |
OrganicFollowerCount | Integer | Total number of the organinc followers. |
PaidFollowerCount | Integer | Total number of the paid followers. |
TimeGranularity | String | Granularity of the statistics. Must be either DAY or MONTH. |
ReportTimeRangeStart | Datetime | Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set. |
ReportTimeRangeEnd | Datetime | Inclusive ending timestamp of when the query should end. Queries until current time when not set. |
UsageStartTime | Datetime | Date start covered by the report data point. Refer to the ReportTimeRangeStart column for the start date of the range covered by the complete report. |
UsageEndTime | Datetime | Date end covered by the report data point. Refer to the ReportTimeRangeEnd column for the end date of the range covered by the complete report. |
Lists all companies and the privileges that the user has within the organization.
Note: Requires the r_organization_admin OAuth scope.
The CompanyList view returns a list of all companies that the member is an administrator of. For example:
SELECT * FROM CompanyList
Name | Type | Description |
Id [KEY] | String | A unique identifier for the company in the following format urn:li:organization:{id} |
RoleAssignee | String | Id of the assigned person. |
Role | String | Role of the assigned person. |
State | String | State of the company. |
Retrieve company locations information.
Note: Requires the r_organization_admin OAuth scope.
The CompanyLocations view supports only the CompanyId column in the WHERE clause. The only supported operator for the CompanyId column is =. For example:
SELECT * FROM CompanyLocations WHERE CompanyId = '183432'
Name | Type | Description |
CompanyId | String | Id of the Company associated with the comment in the following format urn:li:organization:{id} |
Description | String | The company description. Limit of 500 characters. |
LocationType | String | Type of the location. |
Street1 | String | The first line of the street address for the company location. |
Apartment | String | The number of the apatrment,suite etc. for the company location. |
City | String | The city of the company location. |
State | String | The state of the company location. |
PostalCode | String | The postal code of the company location. |
CountryCode | String | The country code of the company location. |
Query statistics about page views for a particular company page.
Note: Requires the r_organization_admin OAuth scope.
The Cloud uses the LinkedIn API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
The CompanyPageStatistics view allows you to retrieve both lifetime and time-bound statistics on views and clicks for an organization page.
SELECT * FROM [CompanyPageStatistics]
SELECT * FROM [CompanyPageStatistics] WHERE ReportTimeRangeStart = '2019-10-20' AND ReportTimeRangeEnd = '2020-10-15' SELECT * FROM [CompanyPageStatistics] WHERE ReportTimeRangeStart = '2019-10-15' AND TimeGranularity = 'DAY' SELECT * FROM [CompanyPageStatistics] WHERE TimeGranularity = 'MONTH' AND ReportTimeRangeStart = '2019-10-15' AND ReportTimeRangeEnd = '2020-10-15' AND companyId = '10904095'
The behavior of TimeGranularity in a query depends on what other inputs are specified.
Inputs specified | Result |
None | The driver returns all data from the time the company page was created until the present time, in one record. |
TimeRangeStart only (no TimeRangeEnd or TimeGranularity) | The driver returns all data from the time specified in TimeRangeStart until the present time, in one record. |
TimeRangeStart and TimeRangeEnd (no TimeRangeGranularity) | The driver returns all data from the time specified in TimeRangeStart until the time specified in TimeRangeEnd, in one record. If the value specified in TimeRangeStart is older than the time when the page was created, it retrieves all data from the time the page was created to the time specified in TimeRangeEnd. |
TimeRangeEnd only (no TimeRangeStart or TimeGranularity) | The driver returns all data from the time the company page was created, until the time specified in TimeRangeEnd, in one record. |
All | The driver breaks down the data into multiple records with different time intervals: one record for every day/month beginning from TimeRangeStart until TimeRangeEnd, depending on the value specified in TimeGranularity. |
Name | Type | Description |
CompanyId | String | Id of the Company associated with the page statistics in the following format urn:li:organization:{id} |
Category | String | The category of the statistics. |
Type | String | Type of the category. Not applicable for the totalPageStatistics category. |
AllPageViews | Integer | Complete page views count. The reported counts may be higher because they include comprehensive mobile and desktop traffic. |
AllDesktopPageViews | Integer | Complete desktop page views count. |
AllMobilePageViews | Integer | Complete mobile page views count. |
OverviewPageViews | Integer | Total Overview page views count. The reported counts may be higher because they include comprehensive mobile and desktop traffic. |
CareersPageViews | Integer | Total Careers page views count. |
DesktopCareersPageViews | Integer | Total desktop Careers page views count. |
DesktopJobsPageViews | Integer | Total desktop Jobs page views count. |
DesktopLifeAtPageViews | Integer | Total desktop Life Atpage views count. |
DesktopOverviewPageViews | Integer | Total desktop Overview page views count. |
JobsPageViews | Integer | Total Jobs page views count. |
LifeAtPageViews | Integer | Total LifeAt page views count. |
MobileCareersPageViews | Integer | Total mobile Careers page views count. |
MobileJobsPageViews | Integer | Total mobile Jobs page views count. |
MobileLifeAtPageViews | Integer | Total mobile LifeAt Page views count. |
MobileOverviewPageViews | Integer | Total mobile Overview page views count. |
MobileProductsPageViews | Integer | Total mobile Products page views count. |
InsightsPageViews | Integer | Total Insights page views count. |
MobileAboutPageViews | Integer | Total mobile About page views count. |
ProductsPageViews | Integer | Total Products page views count. |
DesktopProductsPageViews | Integer | Total desktop Products page views count. |
PeoplePageViews | Integer | Total People page views count. |
DesktopPeoplePageViews | Integer | Total desktop People page views count. |
AboutPageViews | Integer | Total About page views count. |
DesktopAboutPageViews | Integer | Total desktop About page views count. |
MobilePeoplePageViews | Integer | Total mobile People page views count. |
DesktopInsightsPageViews | Integer | Total desktop Insights page views count. |
MobileInsightsPageViews | Integer | Total mobile Insights page views count. |
MobileCareersPagePromoLinksClicks | Integer | Total mobile clicks count on Careers page promo links. Applicable only for the totalPageStatistics category. |
MobileCareersPageJobsClicks | Integer | Total mobile clicks count on Careers page Jobs. Applicable only for the totalPageStatistics category. |
MobileCareersPageEmployeesClicks | Integer | Total mobile clicks count on Careers page Employees. Applicable only for the totalPageStatistics category. |
CareersPagePromoLinksClicks | Integer | Total clicks count on Careers page promo links. Applicable only for the totalPageStatistics category. |
CareersPageBannerPromoClicks | Integer | Total clicks count on Careers page banner promo. Applicable only for the totalPageStatistics category. |
CareersPageJobsClicks | Integer | Total clicks count on Careers page jobs. Applicable only for the totalPageStatistics category. |
CareersPageEmployeesClicks | Integer | Total clicks count on Careers page employees. Applicable only for the totalPageStatistics category. |
TimeGranularity | String | Granularity of the statistics. Must be either DAY or MONTH. |
UsageStartTime | Datetime | Date start covered by the report data point. Refer to the ReportTimeRangeStart column for the start date of the range covered by the complete report. |
UsageEndTime | Datetime | Date end covered by the report data point. Refer to the ReportTimeRangeEnd column for the end date of the range covered by the complete report. |
ReportTimeRangeStart | Datetime | Exclusive starting timestamp of when the query should begin. Queries from beginning of time when not set. |
ReportTimeRangeEnd | Datetime | Inclusive ending timestamp of when the query should end. Queries until current time when not set. |
Lists update events from the LinkedIn company page.
Note: Requires the r_organization_social OAuth scope.
The CompanyStatusUpdates table supports only the CompanyId column in the WHERE clause. The supported operator for the CompanyId column is =. For example:
SELECT * FROM CompanyStatusUpdates WHERE CompanyId = '183432'
Name | Type | Description |
Id [KEY] | String | The unique identifier for the update. |
Comment | String | Comment associated with update status. |
CompanyId | String | Id of the Company associated with the update. |
Date | Datetime | Update created time . |
CreatedBy | String | Id of the person who created update. |
FirstPublishedAt | Datetime | Time when update is published. |
LastModified | Datetime | Last time when changes for this update are made. |
Visibility | String | Visibility of the update. |
LifecycleState | String | State of the update. |
Query update statistics about a company. If the TimeRange filters are not specified, the default result set is for the last 12 months.
Note: Requires the r_organization_admin scope.
The Cloud uses the LinkedIn API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM CompanyUpdateStatistics WHERE CompanyId = '183432' SELECT * FROM CompanyUpdateStatistics WHERE UGCPostId = 'urn:li:ugcPost:1234' SELECT * FROM CompanyUpdateStatistics WHERE UGCPostId IN ('urn:li:ugcPost:1234', 'urn:li:ugcPost:2345')
The behavior of TimeGranularity in a query depends on what other inputs are specified.
Inputs specified | Result |
None | The driver returns all data from the time the company page was created until the present time, in one record. |
TimeRangeStart only (no TimeRangeEnd or TimeGranularity) | The driver returns all data from the time specified in TimeRangeStart until the present time, in one record. |
TimeRangeStart and TimeRangeEnd (no TimeRangeGranularity) | The driver returns all data from the time specified in TimeRangeStart until the time specified in TimeRangeEnd, in one record. If the value specified in TimeRangeStart is older than the time when the page was created, it retrieves all data from the time the page was created to the time specified in TimeRangeEnd. |
TimeRangeEnd only (no TimeRangeStart or TimeGranularity) | The driver returns all data from the time the company page was created, until the time specified in TimeRangeEnd, in one record. |
All | The driver breaks down the data into multiple records with different time intervals: one record for every day/month beginning from TimeRangeStart until TimeRangeEnd, depending on the value specified in TimeGranularity. |
Name | Type | Description |
Clicks | Integer | Total clicks count. |
Comments | Integer | Total comments count. |
CommentMentions | Integer | Total comment mentions count. |
Engagement | Double | Total engagement count. |
Impressions | Integer | Total impressions count. |
Likes | Integer | Total likes count. |
Shares | Integer | Total shares count. |
ShareMentions | Integer | Total share mentions count. |
UniqueImpressions | Integer | Total share mentions count. |
TimeRangeStart | Datetime | Exclusive starting datetime of when the query should begin. When not set, queries from the beginning of time. |
TimeRangeEnd | Datetime | Inclusive ending datetime of when the query should end. When not set, queries until the current time. |
TimeGranularity | String | Granularity of the statistics. Must be either DAY or MONTH. Requires TimeRangeStart and TimeRangeEnd. |
UGCPostId | String | The ID of the UGC post. |
ShareId | String | The ID of the share. |
CompanyId | String | Id of the Company associated with the update statistics. |
IntervalStartTime | Datetime | Date start covered by the report data point. For start date of the range covered by the complete report, see the TimeRangeStart column. |
IntervalEndTime | Datetime | Date end covered by the report data point. For the end date of the range covered by the complete report, see the TimeRangeEnd column. |
Provides the display name for a given geo Id, or a set of geo Ids.
GeoLocation requires an Id in SELECT statements. For example:
SELECT * FROM geolocation where id = 'urn:li:geo:123456'To specify multiple geolocation Ids use the IN operator:
SELECT * FROM geolocation WHERE id IN (<List of geolocation ids>)
Name | Type | Description |
Id [KEY] | String | Unique identifier for the entity. Can be a single Id or a comma-separated list of Ids. |
Country | String | An uppercase two-letter country code as defined by ISO-3166. |
Language | String | A lowercase two-letter language code as defined by ISO-639. |
Value | String | The value of the display text. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
LocaleLanguage | String | The locale language the country data is requested in. A lowercase two-letter language code as defined by ISO-639.
デフォルト値はenです。 |
LocaleCountry | String | The locale country the country data is requested in. An uppercase two-letter country code as defined by ISO-3166.
デフォルト値はUSです。 |
Query the list of available industries in LinkedIn.
Name | Type | Description |
Id [KEY] | Integer | The identifier of the industry. |
Name | String | The name of the industry. |
URN | String | The URN of the industry. |
ParentId | Integer | The identifier of the parent industry of this industry. |
The Organization Follower Count View provides the ability to retrieve the number of first-degree connections (followers) for the organization defined in the CompanyId connection string property.
Name | Type | Description |
FirstDegreeSize | Integer | The number of first-degree connections (followers) for the organization. |
Query profile information of LinkedIn members.
The Profiles view supports filtering only on the Id column and only with the = and IN operators, which are both processed server-side. Refer to the query examples below:
SELECT * FROM Profiles WHERE Id = 'XXXXXXXXXX'; SELECT * FROM Profiles WHERE Id IN ('XXXXXXXXXX', 'YYYYYYYYYY');
Note: Your OAuth tokenRequires the r_basicprofile scope.
Name | Type | Description |
Id [KEY] | String | The unique identifier of the member's profile. |
FirstName | String | The first name of the member's profile. |
LastName | String | The last name of the member's profile. |
MaidenName | String | The maiden name of the member's profile. |
Headline | String | The headline of the member's profile. Often this is the job title. |
VanityName | String | The vanity name of the member's profile. |
PictureAssetURN | String | The digital media asset URN for the picture of the member's profile. |
ストアドプロシージャはファンクションライクなインターフェースで、LinkedIn の単純なSELECT/INSERT 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにLinkedIn から関連するレスポンスデータを返します。
Name | Description |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、LinkedIn のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
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 | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、CompanyStatusUpdates テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='CompanyStatusUpdates'
Name | Type | Description |
CatalogName | String | テーブルまたはビューを含むデータベースの名前。 |
SchemaName | String | テーブルまたはビューを含むスキーマ。 |
TableName | String | カラムを含むテーブルまたはビューの名前。 |
ColumnName | String | カラム名。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | カラムのストレージサイズ。 |
DisplaySize | Int32 | 指定されたカラムの通常の最大幅(文字数)。 |
NumericPrecision | Int32 | 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | カラムのスケール(小数点以下の桁数)。 |
IsNullable | Boolean | カラムがNull を含められるかどうか。 |
Description | String | カラムの簡単な説明。 |
Ordinal | Int32 | カラムのシーケンスナンバー。 |
IsAutoIncrement | String | カラムに固定増分値が割り当てられるかどうか。 |
IsGeneratedColumn | String | 生成されたカラムであるかどうか。 |
IsHidden | Boolean | カラムが非表示かどうか。 |
IsArray | Boolean | カラムが配列かどうか。 |
IsReadOnly | Boolean | カラムが読み取り専用かどうか。 |
IsKey | Boolean | sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベース。 |
SchemaName | String | ストアドプロシージャを含むスキーマ。 |
ProcedureName | String | ストアドプロシージャの名前。 |
Description | String | ストアドプロシージャの説明。 |
ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、SelectEntries ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
ColumnName | String | ストアドプロシージャパラメータの名前。 |
Direction | Int32 | パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | 数値データの小数点以下の桁数。 |
IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
IsArray | Boolean | パラメータが配列かどうか。 |
Description | String | パラメータの説明。 |
Ordinal | Int32 | パラメータのインデックス。 |
主キーおよび外部キーについて説明します。
次のクエリは、CompanyStatusUpdates テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='CompanyStatusUpdates'
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:linkedin: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、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
プロパティ | 説明 |
CompanyId | The company Id of the currently logged on user. If specifying the Company Id in the query, use the format urn:li:organization:{thecompanyid}. |
プロパティ | 説明 |
APIVersion | The version of the LinkedIn Marketing API to be used. |
プロパティ | 説明 |
Scope | A specific scope that the user requires the access token. |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Pagesize | LinkedIn から返されるページあたりの結果の最大数。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
CompanyId | The company Id of the currently logged on user. If specifying the Company Id in the query, use the format urn:li:organization:{thecompanyid}. |
The company Id of the currently logged on user. If specifying the Company Id in the query, use the format urn:li:organization:{thecompanyid}.
string
""
This property must be set in the connection string or query. Otherwise, the Cloud will use the first found company Id.
このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。
プロパティ | 説明 |
APIVersion | The version of the LinkedIn Marketing API to be used. |
The version of the LinkedIn Marketing API to be used.
string
"202401"
The API version used by default is 202401. To use a different API version set this to the format YYYYMM.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
プロパティ | 説明 |
Scope | A specific scope that the user requires the access token. |
A specific scope that the user requires the access token.
string
""
This property must be set in the connection string to get a scoped token with specific privileges.
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
string
""
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Pagesize | LinkedIn から返されるページあたりの結果の最大数。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
int
-1
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
LinkedIn から返されるページあたりの結果の最大数。
int
100
Pagesize プロパティは、LinkedIn から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
string
""
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
int
60
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。