CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるMicrosoft SharePoint へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してMicrosoft SharePoint に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、Microsoft SharePoint への接続を標準化し、構成することができます。
このページでは、CData Cloud でのMicrosoft SharePoint への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのMicrosoft SharePoint への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してMicrosoft SharePoint からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、Microsoft SharePoint に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
URL の設定:
Microsoft SharePoint は、グローバルなMicrosoft SharePoint サイト内のすべてのリストとドキュメント、または個々のサイトのすべてのリストとドキュメントで機能します。
グローバルなMicrosoft SharePoint サイトですべてのリストおよびドキュメントを操作するには、URL 接続プロパティをサイトコレクションURL に設定します。次に例を示します。
https://teams.contoso.com
個々のサイトですべてのリストおよびドキュメントを操作するには、URL 接続プロパティを個々のサイトURL に設定します。次に例を示します。
https://teams.contoso.com/TeamA
以下のセクションでは、使用環境に適した認証プロパティの設定方法について説明します。カスタムOAuth アプリケーション(Web アプリケーションでAzureAD を使用する場合は必須、デスクトップアプリケーションまたはヘッドレスサーバー経由でAzureAD にアクセスする場合はオプション)の作成については、カスタムOAuth アプリケーションの作成 を参照してください。
SharePointEdition を"SharePoint Online" に設定し、User およびPassword をSharePoint へのログオンに使用するクレデンシャルに設定します。例えば、Microsoft Online Services アカウントへのクレデンシャルです。
Microsoft SharePoint Online は、多くのクラウドベースのアーキテクチャをサポートし、各アーキテクチャは、それぞれ異なる認証スキームをサポートしています。
もしユーザーアカウントのドメインがID プロバイダーに設定されたドメインと異なる場合には、SSODomain を後者に設定します。このプロパティは、すべてのSSO で必要になる可能性があります。
Azure テナントの新しいAzureAD アプリケーションを承認する際、組織による管理者の同意が必要になる場合があります。すべてのAzureAD フローにおいて、AzureAD アプリケーションの初期インストールと使用の際は、管理者がそのAzure テナントのアプリケーションを承認する必要があります。詳細はカスタムOAuth アプリケーションの作成 を参照してください。
AuthScheme をADFS に設定します。次の接続プロパティを設定する必要があります。
AuthScheme=ADFS;User=ADFSUserName;Password=ADFSPassword;URL='http://sharepointserver/mysite';
AuthScheme をOkta に設定します。Okta に接続するには、次の接続プロパティを使用します。
接続文字列の例:
AuthScheme=Okta;User=oktaUserName;Password=oktaPassword;URL='http://sharepointserver/mysite';
AuthScheme をOneLogin に設定します。OneLogin への接続には、次の接続プロパティを使用します。
接続文字列の例:
AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;URL='http://sharepointserver/mysite';
AuthScheme をPingFederate に設定します。PingFederate への接続には、次の接続プロパティを使用します。
接続文字列の例:
AuthScheme=PingFederate;User=PingFederateUserName;Password=PingFederatePassword;URL='http://sharepointserver/mysite';
Azure VM 上でMicrosoft SharePoint を実行している場合は、Azure Managed Service Identity(MSI)の資格情報を利用して接続が可能です。
MSI 資格情報が認証用に自動的に取得されます。
AuthScheme をOAuthJWT に設定します。Microsoft SharePoint への接続には、次の接続プロパティを使用します。
AuthScheme をSharePointOAuth に設定します。SharePointOAuth への接続には、次の接続プロパティを使用します。
接続文字列の例:
SharePointEdition='SharepointOnline';URL=https://rssbuscrm.sharepoint.com;Schema=REST;AuthScheme=SharepointOAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=11111111-1111-1111-1111-111111111111;OAuthClientSecret=1111111111111/11111111111111/11111111111111=;このAuthScheme はカスタムOAuth アプリケーションで動作します。カスタムOAuth アプリケーションから認証情報を生成するには、カスタムOAuth アプリケーションの作成 を参照してください。
Kerberos でMicrosoft SharePoint への認証を行うには、AuthScheme をNEGOTIATE に設定します。
Kerberos 経由でMicrosoft SharePoint への認証を行うには、認証プロパティを定義し、Kerberos が認証チケットを取得する方法を選択する必要があります。
Cloud は、 KRB5CCNAME および / またはKerberosKeytabFile 変数が存在するかどうかに応じて、必要なKerberos チケットを取得する3 つの方法を提供します。
MIT Kerberos 資格情報キャッシュファイル
このオプションを使用すると、MIT Kerberos チケットマネージャーまたはkinit コマンドを使ってチケットを取得できます。このオプションでは、User またはPassword 接続プロパティを設定する必要はありません。
このオプションは、KRB5CCNAME がシステムに作成されている必要があります。
MIT Kerberos 資格情報キャッシュファイル経由でチケット検索を有効にするには:
チケットの取得に成功すると、チケット情報がKerberos チケットマネージャーに表示され、クレデンシャルキャッシュファイルに保存されます。
Cloud はキャッシュファイルを使用してMicrosoft SharePoint に接続するためのKerberos チケットを取得します。
Note: KRB5CCNAME を編集したくない場合は、KerberosTicketCache プロパティを使用してファイルパスを手動で設定することができます。この設定後に、Cloud は指定されたキャッシュファイルを使用してMicrosoft SharePoint に接続するためのKerberos チケットを取得します。
Keytab ファイル
お使いの環境にKRB5CCNAME 環境変数がない場合、Keytab ファイルを使用してKerberos チケットを取得できます。
この方法を使用するには、User プロパティを目的のユーザー名に設定し、KerberosKeytabFile プロパティをユーザーに関連付けられたキータブファイルを指すファイルパスに設定します。
User およびPassword
お使いの環境にKRB5CCNAME 環境変数およびKerberosKeytabFile プロパティが設定されていない場合、ユーザーとパスワードの組み合わせを使用してチケットを取得できます。
この方法を使用するには、User およびPassword プロパティを、Microsoft SharePoint での認証に使用するユーザー / パスワードの組み合わせに設定します。
このようなクロスレルム認証を有効にするには、KerberosRealm およびKerberosKDC プロパティをユーザー認証に必要な値に設定します。また、KerberosServiceRealm およびKerberosServiceKDC プロパティを、 サービスチケットの取得に必要な値に設定します。
高度なインテグレーションで簡単にデータにアクセスできるようにするには、次の接続プロパティを使って列名識別子および他のデータ接続の設定を調整します。
デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Microsoft SharePoint Cloud はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
CData Cloud は、Microsoft SharePoint エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。テーブル定義は、Microsoft SharePoint サイトに基づいて 動的に取得されます。カスタムフィールドの追加や、フィールドのデータ型の変更などのあらゆる変更は、接続時に自動的に反映されます。
Cloud は最大数のインテグレーションを行うようにデフォルトで設定されていますが、次の接続プロパティは、高度なインテグレーションで有用な、より粒度の細かいカスタマイズを可能にします。
Cloud は、テーブル にないカスタムリストをMicrosoft SharePoint から公開できます。 データモデルは、SharePoint サイトの外観のサンプルを示します。実際のデータモデルは、ユーザー資格情報とSharePoint サイトに基づいて動的に取得されます。
一般的に、変更ができないエンティティはビュー、または読み取り専用のテーブルとして表示されます。また、リストのカスタムビューをリレーショナルビューとしてアクセスすることができます。
リストのカスタムビューからデータを取得するには、ViewID 疑似列をWHERE 句に設定します。
SELECT * FROM ListName WHERE ViewID='ID of the view'Views リストからビューのID を取得できます。そのリストビューのリストを取得するには、List 疑似列を指定する必要があります。 次に例を示します。
SELECT * FROM Views WHERE List ='ListName'
Cloud はMicrosoft SharePoint のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Name | Description |
Attachments | Reads or deletes attachments to the specified item on the specified list. |
Groups | Creates, updates, deletes, and queries Groups from SharePoint. |
Roles | Creates, updates, deletes, and queries Roles from SharePoint. |
Users | Updates, deletes, and queries Users from SharePoint. |
Views | Creates, updates, deletes, and queries the available lists in SharePoint. |
Reads or deletes attachments to the specified item on the specified list.
Attachment を戻すにはリストとリストID が必要です。
リスト項目に新しい添付ファイルを追加するには、AddAttachments ストアドプロシージャを呼び出します。
Name | Type | ReadOnly | Description |
Url [KEY] | String | True |
Description of the term set. |
List | String | True |
The internal name of the list to retrieve attachments from. |
ListDisplayName | String | True |
The display name of the list to retrieve attachments from. |
ItemID | String | True |
The Id of the item on the list to retrieve attachments from. |
Name | String | True |
The name of the attachment on the item. |
Creates, updates, deletes, and queries Groups from SharePoint.
このテーブルに挿入するにはName、DefaultLogin、およびOwnerLogin カラムが必要です。
UserName 疑似カラムを使用するには、ユーザーのLoginName に値を設定する必要があります。Users テーブルにクエリすることでLoginName を取得できます。
Name | Type | ReadOnly | Description |
Name# [KEY] | String | False |
The name of the group. |
Description# | String | False |
A description of the group. |
OwnerLogin# | String | False |
The user name of the owner of the group. This value should be in the format DOMAIN\\username. |
OwnerType# | String | False |
The type of owner. User or group. |
DefaultLogin# | String | False |
The user name of the default user for the group. This value should be in the format DOMAIN\\username. |
SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
UserName | String |
The logical name of the user to return groups for. Specify this value on the SELECT statement to return only groups the specified User is in. |
Creates, updates, deletes, and queries Roles from SharePoint.
UserName 疑似カラムを使用するには、ユーザーのLoginName に値を設定する必要があります。Users テーブルにクエリすることでLoginName を取得できます。
Role を挿入するには、最低でもName が必要です。
INSERT INTO Roles (Name) VALUES ('My Role')
Name | Type | ReadOnly | Description |
Name# [KEY] | String | False |
The name of the role. |
Description# | String | False |
A description of the role. |
Permissions# | Long | False |
A long representing the permissions for the role. |
RoleType | String | True |
The type of role. |
IsHidden | Boolean | True |
A boolean indicating if the role is hidden. |
SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
UserName | String |
The login name of the user to return roles for. Specify this value on a SELECT statement to return only roles assigned to the specified user. |
GroupName | String |
The name of the group to return roles for. Specify this value on a SELECT statement to return only roles assigned to the specified group. |
Updates, deletes, and queries Users from SharePoint.
SharePoint Account のために作成されたすべてのユーザーを取得する:
SELECT * FROM Users
1つのグループに所属するすべてのユーザーを取得することも可能です。その場合には、Group Name を指定します。
SELECT * FROM Users WHERE [Group] = "GroupName"
指定されたロールを持つユーザーを取得することも可能です。その場合には、Role Name を指定します。
SELECT * FROM Users WHERE [Role] = "RoleName"
Name | Type | ReadOnly | Description |
ID | String | True |
The Id of the user. |
LoginName# [KEY] | String | False |
The login name of the user. |
Name# | String | False |
The name of the user. |
Email# | String | False |
The email address of the user. |
IsInDomainGroup | Boolean | True |
A boolean indicating if the user is in the domain group. |
IsSiteAdmin | Boolean | True |
A boolean indicating if the user is a site admin. |
Notes# | String | False |
Optional notes concerning the user. |
SecurityId | String | True |
The security Id (SID) for the user. |
SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
Group | String |
The group you are adding a user to and selecting or deleting the user from. This is an input-only value and you must specify either Group or Role for inserts and selects, but you can optionally specify deletions. |
Role | String |
The role you are adding a user to and selecting or deleting the user from. This is an input-only value and you must specify either Group or Role for inserts and selects, but but you can optionally specify deletions. |
Creates, updates, deletes, and queries the available lists in SharePoint.
Views は特別なテーブルです。これを使用して、指定されたリストのビューを取得、更新、挿入、および削除できます。
SELECT * FROM Views WHERE List = 'MyListName'
このテーブルに挿入するにはList、Name、Type、およびFields カラムが必要です。
Name | Type | ReadOnly | Description |
ID [KEY] | String | True |
The Id of the view. |
List | String | True |
The list the view is associated with. A list must be specified when performing SELECT statements if the Id is not specified. |
ViewID | String | True |
The Id of the view. May only be unique for the specific list. |
Name | String | False |
The name of the view. |
Type | String | False |
The type of view. This must have a value on inserts and updates. 使用できる値は次のとおりです。CALENDAR, GRID, HTML デフォルト値はHTMLです。 |
Fields | String | False |
A comma-separated list of the fields associated with the view. This is space-sensitive. |
IsDefault | Boolean | False |
A boolean indicating if the view is the default view for the list. |
Query | String | False |
A query for the view. |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
FileVersions | Lists the versions of files available on SharePoint. |
GetValidTerms | Gets a list of valid terms for the specified column on the specified table. |
Lists | Lists the available lists in SharePoint. |
Permissions | The permissions for a site or list. Note: If ItemId is empty, set the ObjectType to List or web (an ObjectName must be specified when the ObjectType is list). If not, you must specify the ObjectName along with the ItemID. |
Subsites | Lists the available subsites. |
Lists the versions of files available on SharePoint.
このビューから結果を返すには、Library およびFile を指定する必要があります。
Name | Type | Description |
ID [KEY] | String | The Id of the version. |
Comments | String | Comments about the particular version. |
CreateBy | String | The username of the SharePoint user who modified this version of the file. |
Date | Datetime | When the file was modified. |
Size | String | The size of this version of the file. |
Url | String | The URL to this version of the file. |
Library | String | The library name on SharePoint you are listing versions from. A library must be specified to retrieve the versions for a file.
デフォルト値はShared Documentsです。 |
File | String | The name of the file on SharePoint to list versions for. You must specify a file to retrieve the versions for a file. |
Gets a list of valid terms for the specified column on the specified table.
GetValidTerms は特別なビューです。これを使用して、特定のリストの分類列または管理されたメタデータ列に対して有効な用語を取得できます。このビューを使用するには、テーブルの名前と、有効な用語の取得元になる列を指定します。次に例を示します。
SELECT * FROM GetValidTerms WHERE List = 'MyListName' AND ColumnName = 'MyManagedMetadataColumn'
Name | Type | Description |
ID [KEY] | String | The identifier of the term. |
TermLabelValue | String | The label of the term. |
Description | String | Description of the term set. |
NameInRequestedLang | String | The name of the term set in the language requested by the client. |
IsOpen | Boolean | A Boolean indicating if the term set is open. |
Deprecated | Boolean | A Boolean indicating if the term is deprecated. |
InternalId | String | An internal identifier for the term. |
TermSetContact | String | The term set contact. |
ContainerDesc | String | The container node for the description. |
SingleTermLabelDesc | String | This fully describes a single term label. |
IsDefaultLabel | Boolean | True if the term label is the default term label. |
BelongsTo | String | This item describes a term set to which a term belongs. |
IsTaggingAvailable | Boolean | If the term set is available for tagging, this value is true. |
TermPath | String | Term path of the term with term labels. |
TermpathoftermwithIds | String | Term path of term with identifiers. |
ChildTerms | String | A string value that indicates a custom sort order for the child terms of the term identified by PertainingToTerm. |
HasChildTerms | Boolean | True if the term has child terms. |
PertainingToTerm | String | An identifier of the term that this term set information is pertaining to. |
SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
List | String | The name of the list to get valid terms for. |
ColumnName | String | The name of the column to get valid terms for. |
LocaleId | String | The locale Id for the term. Defaults to 1033. |
Lists the available lists in SharePoint.
Lists を使用して、SharePoint のテーブルをリストできます。これは、SharePoint 内の実際のリストだけを返します。Cloud に関連付けられた特別なテーブルは返しません。
WHERE 句で次の列を使用できます:Title およびBaseTemplage。
Name | Type | Description |
ID [KEY] | String | The Id of the list. |
Title | String | The title of the list. This column may be used in the WHERE clause and may be used with a wild card (*) character. |
Description | String | A description for the list. |
BaseTemplate | String | Indicates the type of template used to create the list. This column may be used in the WHERE clause. |
Version | Double | The version of the list. |
Url | String | The default URL of the list. |
EmailAlias | String | The email alias of the list. |
ImageUrl | String | The image URL of the list. |
ItemCount | Integer | The number of items in the list. |
Item_Deleted | Datetime | The last time an item was deleted from this list. |
Item_Modified | Datetime | The last time an item was modified from this list. |
SendToUrl | String | The send-to URL of the list. |
Created | Datetime | The time when the list was created. |
AllowDeletion | String | Whether items can be deleted. |
AllowMultiResponses | Boolean | A Boolean indicating if multiple responses are enabled for the survey. |
Direction | String | A string that contains LTR if the reading order is left-to-right, RTL if it is right-to-left, or None. |
EnableAssignedToEmail | Boolean | A Boolean indicating if assigned-to emails are enabled. Only applies to issues lists. |
EnableAttachments | Boolean | A Boolean indicating if attachments may be added to items in the list. Does not apply to document libraries. |
EnableModeration | Boolean | A Boolean indicating if content approval is enabled for the list. |
EnableVersioning | Boolean | A Boolean indicating if versioning is enabled for the list. |
Hidden | Boolean | A Boolean indicating if the list is hidden so that it does not appear on the Documents and Lists page, Quick Launch bar, Modify Site Content page, or Add Column page as an option for lookup fields. |
MultipleDataList | Boolean | A Boolean indicating if a meeting-workspace site contains data for multiple meeting instances within the site. |
Ordered | Boolean | A Boolean indicating if items in the list can be sorted on the Edit View page. |
Showuser | Boolean | A Boolean indicating if the names of users are shown in the results of the survey. |
The permissions for a site or list. Note: If ItemId is empty, set the ObjectType to List or web (an ObjectName must be specified when the ObjectType is list). If not, you must specify the ObjectName along with the ItemID.
Name | Type | Description |
MemberID [KEY] | String | The Id of the permission. |
Mask | Long | A 32-bit integer in 0x00000000 format that represents a Microsoft.SharePoint.SPRights value and defines the permission. Use the pipe symbol ('|') in C# or Or in Microsoft Visual Basic to delimit values when creating a custom permission mask that combines permissions. |
MemberIsUser | Bool | Indicate whether it is the permission for user. |
MemberGlobal | Bool | Indicate whether it is the permission for group. |
RoleName | String | A string that contains the name of the site group, the name of the cross-site group, or the user name (DOMAIN\User_Alias) of the user to whom the permission applies. |
SELECT ステートメントのWHERE 句では、疑似列フィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
ObjectName | String | A string that contains the name of the list or site. |
ObjectType | String | A string that specifies either List or Web. |
ItemID | String | Id of the item. |
Lists the available subsites.
Name | Type | Description |
Title | String | The name of the subsite. |
Url | String | The url of the subsite. |
ストアドプロシージャはファンクションライクなインターフェースで、Microsoft SharePoint の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMicrosoft SharePoint から関連するレスポンスデータを返します。
Name | Description |
AddAttachment | SharePoint リスト項目に添付ファイルを追加します。 |
AddList | SharePoint サイト上にリストを作成します。 |
AddListColumn | 指定されたリストに新しいカラムを追加します。 |
AddUserToGroup | ユーザーを指定したグループに追加します。 |
AddUserToRole | ユーザーを指定したロールに追加します。 |
CheckInDocument | SharePointにドキュメントをチェックインし、ドキュメントのロックを解除します。 |
CheckOutDocument | SharePointからドキュメントをチェックアウトします。 |
CopyDocument | SharePointライブラリからドキュメントをコピーします。 |
CreateFolder | SharePointサイトのドキュメントライブラリにフォルダを追加します。 |
DeleteAttachment | SharePointリスト項目から添付ファイルを削除します。 |
DeleteDocument | SharePointライブラリからドキュメントを削除します。 |
DeleteList | SharePoint サイトからリストを完全に削除します。 |
DeleteListColumn | 指定されたリストからカラムを削除します。 |
DeleteUserFromGroup | ユーザーを指定したグループから削除します。 |
DeleteUserFromRole | ユーザーを指定したロールから削除します。 |
DiscardCheckOutDocument | SharePoint内のドキュメントのチェックアウトを破棄します。これは新しいファイルをSharePoint にチェックインすることはしません。ドキュメントのロックを解除するだけです。 |
MoveAttachmentOrDocument | Moves a document or attachment from a source folder to a destination folder. |
RenameAttachmentOrDocument | Renames a document or attachment. |
AddList | SharePoint サイト上のリストを更新します。 |
UpdateListColumn | 指定されたリスト上のカラムを更新します。 |
SharePoint リスト項目に添付ファイルを追加します。
Name | Type | Description |
File | String | 追加されるローカルファイルのパス。 |
List | String | SharePoint サーバー上のリストの名前。 |
ItemID | String | 添付ファイルの追加先になるリスト内の項目のId。 |
FileName | String | アップロードするファイル名。コンテンツがNull でない場合に使用します。例えば、test.csv です。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
URL | String | 新しく作成された項目のURL。 |
SharePoint サイト上にリストを作成します。
Name | Type | Description |
Name | String | SharePoint サーバー上のリストの名前。 |
Template | String | リスト作成のためのテンプレート名。
使用できる値は次のとおりです。GenericList, DocumentLibrary, Survey, Links, Announcements, Contacts, Events, Tasks, DiscussionBoard, PictureLibrary, DataSources, WebTemplateCatalog, UserInformation, WebPartCatalog, ListTemplateCatalog, XMLForm, MasterPageCatalog, NoCodeWorkflows, WorkflowProcess, WebPageLibrary, CustomGrid, DataConnectionLibrary, WorkflowHistory, GanttTasks, Meetings, Agenda, MeetingUser, Decision, MeetingObjective, TextBox, ThingsToBring, HomePageLibrary, Posts, Comments, Categories, IssueTracking, AdminTasks デフォルト値はGenericListです。 |
Description | String | 追加するリストの説明。 |
Columns | String | 追加するカラムの定義。json/xml/tempTable をサポート。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
SharePoint サイト上のリストを更新します。
Name | Type | Description |
List | String | SharePoint サーバー上のリストの名前。 |
AllowMultiResponses | String | アンケートに複数回答を許可するには、True に設定します。 |
Description | String | リストの説明を含む文字列。 |
Direction | String | 読みの方向を示す文字列。LTR(左から右)、RTL(右から左)、またはNone。 |
EnableAssignedToEmail | String | True に設定すると、issue リストの指定受信メールが有効になります。 |
EnableAttachments | String | True に設定すると、リスト内のアイテムに添付できるようになります。ドキュメントライブラリには適用されません。 |
EnableModeration | String | True に設定すると、リストのContent Approval が有効になります。 |
EnableVersioning | String | True に設定すると、リストのバージョン管理が有効になります。 |
Hidden | String | True に設定すると、[ドキュメントとリスト]ページ、クイック起動バー、[サイトコンテンツの変更]ページ、および[列の追加]ページに、ルックアップフィールドのオプションとしてリストが表示されなくなります。 |
MultipleDataList | String | True に設定すると、会議ワークスペースサイトのリストに、サイト内の複数の会議インスタンスのデータが含まれるようにします。 |
Ordered | String | True に設定すると、ユーザーがリスト内のアイテムを並べ替えることができるオプションをリストの[ビューの編集]ページで使用できるようになります。 |
ShowUser | String | True に設定すると、アンケートの結果にユーザーの名前が表示されるようになります。 |
Title | String | リストのタイトルを含む文字列。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
指定されたリストに新しいカラムを追加します。
Name | Type | Description |
List | String | SharePoint サーバー上のリストの名前。 |
ColumnName | String | 追加するカラム名。 |
DisplayName | String | 追加するカラムの表示名。 |
DefaultValue | String | 追加するカラムのデフォルト値。 |
ColumnType | String | 追加するカラムのデータ型。有効なオプションは、SharePoint API で利用可能なFieldTypes で定義されています(https://docs.microsoft.com/en-us/previous-versions/office/sharepoint-csom/ee540543(v=office.15))。 |
MaxLength | String | 追加するカラムの最大長。 |
PrimaryKey | String | カラムが主キーかどうかを示すBoolean。 |
ReadOnly | String | カラムが読み取り専用かどうかを示すBoolean。 |
Required | String | カラムが必須かどうかを示すBoolean。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
ユーザーを指定したグループに追加します。
Name | Type | Description |
LoginName | String | ユーザーのログイン名。 |
Group | String | ユーザーを追加、および選択/削除する先のグループ。これは入力専用の値です。挿入および選択の場合はGroup またはRole を指定する必要がありますが、削除の場合はオプションです。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
ユーザーを指定したロールに追加します。
Name | Type | Description |
LoginName | String | ユーザーのログイン名。 |
Role | String | ユーザーを追加、および選択/削除する先のロール。これは入力専用の値です。挿入および選択の場合はGroup またはRole を指定する必要がありますが、削除の場合はオプションです。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
SharePointにドキュメントをチェックインし、ドキュメントのロックを解除します。
Name | Type | Description |
File | String | SharePoint内のドキュメントを上書きするために使用するファイルのパス。例:C:\myfolder\myfile.txt。 |
Library | String | SharePoint サーバー上のライブラリの名前。例:Shared Documents. |
Comment | String | ファイルをチェックインするときに残すコメント。 |
RemoteFile | String | サーバー上のファイルのパス。これには、完全URLまたは単純にファイル名を指定することができます。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
SharePointからドキュメントをチェックアウトします。
Name | Type | Description |
Library | String | SharePoint サーバー上のライブラリの名前。 |
RemoteFile | String | サーバー上のファイルのパス。これには、完全URLまたは単純にファイル名を指定することができます。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
SharePointライブラリからドキュメントをコピーします。
Note:このプロシージャは、インデックス付きパラメータを使用します。 インデックス付きパラメータは、プロシージャの入力として単一のパラメータを複数のインスタンスに提供することを容易にします。
Param# という名前の入力パラメータがあるとします。このようなインデックス付きパラメータの複数のインスタンスを入力するには、次のように実行します。
EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
以下の表では、インデックス付きの入力パラメータは、名前の末尾に '#' 文字が付きます。
Name | Type | Description |
DocumentName | String | コピーされるドキュメントライブラリ内のドキュメントの名前。 |
DocumentLibrary | String | ドキュメントが現在保管されているドキュメントライブラリの名前。 |
NewDocumentLibrary | String | ドキュメントのコピー先のドキュメントライブラリの名前。 |
NewDocumentName | String | コピー後のドキュメントの新しい名前。空欄のままにすると、新しい名前はDocumentNameと同じになります。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
Id | String | ドキュメントのId。 |
DocumentId | String | ドキュメントId。 |
DocumentIdUrl | String | ドキュメントId のURL。 |
FileRef | String | ドキュメントのファイル参照。 |
SharePointサイトのドキュメントライブラリにフォルダを追加します。
Name | Type | Description |
Library | String | SharePoint サーバー上のライブラリの名前。 |
Name | String | ドキュメントの追加先のフォルダの名前。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
SharePointリスト項目から添付ファイルを削除します。
Name | Type | Description |
URL | String | 削除される添付ファイルの完全URL。 |
List | String | SharePoint サーバー上のリストの名前。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
SharePointライブラリからドキュメントを削除します。
Name | Type | Description |
Library | String | SharePoint サーバー上のライブラリの名前。 |
Path | String | ドキュメントライブラリから削除するファイル(またはフォルダ)のパス。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
SharePoint サイトからリストを完全に削除します。
Name | Type | Description |
List | String | SharePoint サーバー上のリストの名前。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
指定されたリストからカラムを削除します。
Name | Type | Description |
List | String | SharePoint サーバー上のリストの名前。 |
ColumnName | String | 削除するカラム名。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
ユーザーを指定したグループから削除します。
Name | Type | Description |
LoginName | String | ユーザーのログイン名。 |
Group | String | ユーザーを追加、および選択/削除する先のグループ。これは入力専用の値です。挿入および選択の場合はGroup またはRole を指定する必要がありますが、削除の場合はオプションです。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
ユーザーを指定したロールから削除します。
Name | Type | Description |
LoginName | String | ユーザーのログイン名。 |
Role | String | ユーザーを追加、および選択/削除する先のロール。これは入力専用の値です。挿入および選択の場合はGroup またはRole を指定する必要がありますが、削除の場合はオプションです。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
SharePoint内のドキュメントのチェックアウトを破棄します。これは新しいファイルをSharePoint にチェックインすることはしません。ドキュメントのロックを解除するだけです。
Name | Type | Description |
Library | String | SharePoint サーバー上のライブラリの名前。 |
RemoteFile | String | チェックアウトされるファイルの名前。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
Moves a document or attachment from a source folder to a destination folder.
The MoveAttachmentOrDocument stored procedure requires the List, SourceFileURL and DestinationFolderURL parameters to move an attachment or document.
For Example:
EXEC MoveAttachmentOrDocument List = 'Test134', SourceFileURL = '/Shared Documents/Dummy.txt', DestinationFolderURL = '/Shared Documents/MySite'
Name | Type | Description |
List | String | The name of the list from which you want to move the document or attachment. |
SourceFileURL | String | The URL of the source file, relative to the base Url supplied in the Cloud's connection properties. For example: Root Directory file: /Shared Documents/filename.txt Sub-directory file:/Shared Documents/MyFolder/filename.txt If you set the Url connection property to a site collection, the relative URL corresponds with a path on the base site. If the Url connection property points to a specific site, the relative URL will be relative to the site supplied in the Url. |
DestinationFolderURL | String | The URL of the destination folder where you want to move the file, relative to the base Url supplied in the Cloud's connection properties. For example: Root Directory: /Shared Documents/ Sub-directory:/Shared Documents/MyFolder/ If you set the Url connection property to a site collection, the relative URL corresponds to a path on the base site. If the Url connection property points to a specific site, the relative URL is relative to the site supplied in the Url. |
Name | Type | Description |
Success | Boolean | Indicates whether the operation was successful or not. |
Renames a document or attachment.
The RenameAttachmentOrDocument stored procedure requires the List, SourceFileURL and NewFileName parameters to rename an attachment or document.
For Example:
EXEC RenameAttachmentOrDocument List = 'Test134', SourceFileURL = '/Shared Documents/Dummy.txt', NewFileName = 'Dummy1.txt'
Name | Type | Description |
List | String | Name of the list containing the document or attachment you would like to rename. |
SourceFileURL | String | URL of the file you want to rename, relative to the base Url supplied in the Cloud's connection properties. For example: Root Directory file: /Shared Documents/filename.txt Sub-directory file:/Shared Documents/MyFolder/filename.txt If you set the Url connection property to a site collection, the relative URL corresponds with a path to the base site. If the Url connection property points to a specific site, the relative URL is relative to the site supplied in the Url. |
NewFileName | String | New name of the file, with extension. |
Name | Type | Description |
Success | Boolean | Indicates whether the operation was successful or not. |
SharePoint サイト上にリストを作成します。
Name | Type | Description |
Name | String | SharePoint サーバー上のリストの名前。 |
Template | String | リスト作成のためのテンプレート名。
使用できる値は次のとおりです。GenericList, DocumentLibrary, Survey, Links, Announcements, Contacts, Events, Tasks, DiscussionBoard, PictureLibrary, DataSources, WebTemplateCatalog, UserInformation, WebPartCatalog, ListTemplateCatalog, XMLForm, MasterPageCatalog, NoCodeWorkflows, WorkflowProcess, WebPageLibrary, CustomGrid, DataConnectionLibrary, WorkflowHistory, GanttTasks, Meetings, Agenda, MeetingUser, Decision, MeetingObjective, TextBox, ThingsToBring, HomePageLibrary, Posts, Comments, Categories, IssueTracking, AdminTasks デフォルト値はGenericListです。 |
Description | String | 追加するリストの説明。 |
Columns | String | 追加するカラムの定義。json/xml/tempTable をサポート。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
SharePoint サイト上のリストを更新します。
Name | Type | Description |
List | String | SharePoint サーバー上のリストの名前。 |
AllowMultiResponses | String | アンケートに複数回答を許可するには、True に設定します。 |
Description | String | リストの説明を含む文字列。 |
Direction | String | 読みの方向を示す文字列。LTR(左から右)、RTL(右から左)、またはNone。 |
EnableAssignedToEmail | String | True に設定すると、issue リストの指定受信メールが有効になります。 |
EnableAttachments | String | True に設定すると、リスト内のアイテムに添付できるようになります。ドキュメントライブラリには適用されません。 |
EnableModeration | String | True に設定すると、リストのContent Approval が有効になります。 |
EnableVersioning | String | True に設定すると、リストのバージョン管理が有効になります。 |
Hidden | String | True に設定すると、[ドキュメントとリスト]ページ、クイック起動バー、[サイトコンテンツの変更]ページ、および[列の追加]ページに、ルックアップフィールドのオプションとしてリストが表示されなくなります。 |
MultipleDataList | String | True に設定すると、会議ワークスペースサイトのリストに、サイト内の複数の会議インスタンスのデータが含まれるようにします。 |
Ordered | String | True に設定すると、ユーザーがリスト内のアイテムを並べ替えることができるオプションをリストの[ビューの編集]ページで使用できるようになります。 |
ShowUser | String | True に設定すると、アンケートの結果にユーザーの名前が表示されるようになります。 |
Title | String | リストのタイトルを含む文字列。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
指定されたリスト上のカラムを更新します。
Name | Type | Description |
List | String | SharePoint サーバー上のリストの名前。 |
ColumnName | String | 更新するカラム名。 |
DisplayName | String | 表示名の更新後の値。 |
DefaultValue | String | 指定されたカラムの更新後のデフォルト値。 |
ColumnType | String | 指定されたカラムの更新後のデータ型。 |
MaxLength | String | 指定されたカラムの更新後の最大長。 |
PrimaryKey | String | 既存のカラムを主キーに設定する場合に使用します。 |
ReadOnly | String | 既存のカラムを読み取り専用に設定する場合に使用します。 |
Required | String | 既存のカラムを読み取り専用に設定する場合に使用します。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
CData Cloud は、Microsoft SharePoint エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。テーブル定義は、Microsoft SharePoint サイトに基づいて 動的に取得されます。カスタムフィールドの追加や、フィールドのデータ型の変更などのあらゆる変更は、接続時に自動的に反映されます。
テーブルは動的に生成されるため、特定のテーブルに関するドキュメントはありません。
ビューは変更ができないテーブルです。一般的に、読み取り専用のデータはビューとして表示されます。
REST API はOData に準拠しているため、サーバーサイドフィルタはOData 標準を使用して実行されます。そのためドライバーは、メタデータファイルを読み取ってどのフィルタがサーバーで実行できるかを決定することで、サーバーフィルタリングを最大限に活用します。
NOTE: "SELECT *" クエリを実行する際には、Microsoft SharePoint REST API レスポンスは利用可能なすべてのフィールドを返すわけではありません。そこで、大量にnull 値が発生してしまうことを避けるためプロバイダーは、明示的に
$select フィルタを使用しているカラムをすべて選択します。ただし、URL の長さに関するMicrosoft SharePoint REST API からのエラーを避けるため、$select フィルタの長さが1500以下である場合のみ、プロバイダーはこの操作を実行します。これはMicrosoft SharePoint REST API の制限であり、こうした場合にはいくつかのカラムの実際の値を見るには、クエリ内で明示的に選択する以外に方法はありません。
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
Attachments | Reads attachments for the specified item on the specified list. |
Files | Query the available files on your sharepoint site. |
Groups | Query the available groups on your sharepoint site. |
Lists | Query the available lists on your sharepoint site. |
RoleAssignmentMember | Get Web RoleAssignments member. |
RoleAssignments | Get Web RoleAssignments. |
RoleDefinitionBindings | Get Web Role definition binding. |
Roles | Query the roles your users can have. |
Subsites | This lists the available subsites. |
Users | Query the available users on your sharepoint site. |
Reads attachments for the specified item on the specified list.
Note: List and ItemId are required to return Attachments.
List can be fetched from the Lists view(Title column).
SELECT * FROM Attachments WHERE List = 'TestApp' AND ItemID = 1
Name | Type | References | Description |
Id [KEY] | String | The Id of the attachment on the item. | |
Updated | Datetime | The updated date of the attachment to the item. | |
FileName | String | The FileName of the attachment to the item. | |
ServerRelativePath_DecodedUrl | String | The ServerRelativePath DecodedUrl of the attachment to the item. | |
FileNameAsPath_DecodedUrl | String | The FileNameAsPath DecodedUrl of the attachment to the item. | |
ServerRelativeUrl | String | The ServerRelativeUrl of the attachment to the item. | |
List | String | The internal name of the list to retrieve attachments from. | |
ItemID | String | The Id of the item on the list to retrieve attachments from. |
Query the available files on your sharepoint site.
Name | Type | References | Description |
Id [KEY] | String | ||
CreatedBy_Id | String | ||
CreatedBy_Name | String | ||
CreatedBy_Puid | String | ||
ETag | String | ||
LastModifiedBy_Id | String | ||
LastModifiedBy_Name | String | ||
LastModifiedBy_Puid | String | ||
Name | String | ||
Size | Int | ||
TimeCreated | Datetime | ||
TimeLastModified | Datetime | ||
Url | String |
Query the available groups on your sharepoint site.
SELECT * FROM Groups
Name | Type | References | Description |
Id [KEY] | Int | The Group Id. | |
AllowMembersEditMembership | Bool | ||
AllowRequestToJoinLeave | Bool | ||
AutoAcceptRequestToJoinLeave | Bool | ||
CanCurrentUserEditMembership | Bool | ||
CanCurrentUserManageGroup | Bool | ||
CanCurrentUserViewMembership | Bool | ||
Description | String | ||
OnlyAllowMembersViewMembership | Bool | ||
OwnerTitle | String | ||
RequestToJoinLeaveEmailSetting | String | ||
LinkedOwner | String | ||
LinkedUsers | String |
Query the available lists on your sharepoint site.
Name | Type | References | Description |
HasUniqueRoleAssignments [KEY] | Bool | ||
LinkedFirstUniqueAncestorSecurableObject | String | ||
LinkedRoleAssignments | String | ||
ServerRelativeUrl | String | The relative URL of the file based on the URL for the server. This column is available when the URL is a subsite. | |
Id [KEY] | String | ||
AllowContentTypes | Bool | ||
AllowDeletion | Bool | ||
BaseTemplate | Int | ||
BaseType | Int | ||
BrowserFileHandling | Int | ||
ContentTypesEnabled | Bool | ||
CrawlNonDefaultViews | Bool | ||
Created | Datetime | ||
CurrentChangeToken_StringValue | String | ||
CustomActionElements_Items | String | ||
DataSource_Properties | String | ||
DefaultContentApprovalWorkflowId | String | ||
DefaultDisplayFormUrl | String | ||
DefaultEditFormUrl | String | ||
DefaultItemOpenUseListSetting | Bool | ||
DefaultNewFormUrl | String | ||
DefaultViewPath_DecodedUrl | String | ||
DefaultViewUrl | String | ||
Description | String | ||
Direction | String | ||
DisableGridEditing | Bool | ||
DocumentTemplateUrl | String | ||
DraftVersionVisibility | Int | ||
EffectiveBasePermissions_High | Long | ||
EffectiveBasePermissions_Low | Long | ||
EffectiveBasePermissionsForUI_High | Long | ||
EffectiveBasePermissionsForUI_Low | Long | ||
EnableAssignToEmail | Bool | ||
EnableAttachments | Bool | ||
EnableFolderCreation | Bool | ||
EnableMinorVersions | Bool | ||
EnableModeration | Bool | ||
EnableRequestSignOff | Bool | ||
EnableVersioning | Bool | ||
EntityTypeName | String | ||
ExcludeFromOfflineClient | Bool | ||
ExemptFromBlockDownloadOfNonViewableFiles | Bool | ||
FileSavePostProcessingEnabled | Bool | ||
ForceCheckout | Bool | ||
HasExternalDataSource | Bool | ||
Hidden | Bool | ||
ImagePath_DecodedUrl | String | ||
ImageUrl | String | ||
IrmEnabled | Bool | ||
IrmExpire | Bool | ||
IrmReject | Bool | ||
IsApplicationList | Bool | ||
IsCatalog | Bool | ||
IsEnterpriseGalleryLibrary | Bool | ||
IsPrivate | Bool | ||
IsSiteAssetsLibrary | Bool | ||
IsSystemList | Bool | ||
ItemCount | Int | ||
LastItemDeletedDate | Datetime | ||
LastItemModifiedDate | Datetime | ||
LastItemUserModifiedDate | Datetime | ||
ListExperienceOptions | Int | ||
ListItemEntityTypeFullName | String | ||
MajorVersionLimit | Int | ||
MajorWithMinorVersionsLimit | Int | ||
MultipleDataList | Bool | ||
NoCrawl | Bool | ||
OnQuickLaunch | Bool | ||
PageRenderType | Int | ||
ParentWebPath_DecodedUrl | String | ||
ParentWebUrl | String | ||
ParserDisabled | Bool | ||
ReadSecurity | Int | ||
SchemaXml | String | ||
ServerTemplateCanCreateFolders | Bool | ||
TemplateFeatureId | String | ||
Title | String | ||
ValidationFormula | String | ||
ValidationMessage | String | ||
WriteSecurity | Int | ||
LinkedContentTypes | String | ||
LinkedCreatablesInfo | String | ||
LinkedDefaultView | String | ||
LinkedDescriptionResource | String | ||
LinkedEventReceivers | String | ||
LinkedFields | String | ||
LinkedForms | String | ||
LinkedInformationRightsManagementSettings | String | ||
LinkedItems | String | ||
LinkedParentWeb | String | ||
LinkedRootFolder | String | ||
LinkedSubscriptions | String | ||
LinkedTitleResource | String | ||
LinkedUserCustomActions | String | ||
LinkedViews | String | ||
LinkedWorkflowAssociations | String |
Get Web RoleAssignments member.
Note: PrincipalId is required to return RoleAssignmentMember.
SELECT * FROM RoleAssignmentMember WHERE PrincipalId = 3 SELECT * FROM RoleAssignmentMember WHERE List = 'TestApp' AND PrincipalId = 3 SELECT * FROM RoleAssignmentMember WHERE PrincipalId = 5 AND list = 'KatsunariMatsumoto' AND ItemId = '3'
Name | Type | References | Description |
ID [KEY] | String | The ID of the role assigned member. | |
Updated | Datetime | The updated date for role assigned member. | |
IsHiddenInUI | Boolean | A boolean indicating if the assigned role member is hidden in UI. | |
LoginName | String | The login name of the role assigned member. | |
Title | String | The title of the role assigned member. | |
AllowMembersEditMembership | Boolean | A boolean indicating whether to allow members edit membership. | |
AllowRequestToJoinLeave | Boolean | A boolean indicating whether to allow request to join leave. | |
AutoAcceptRequestToJoinLeave | Boolean | A boolean indicating whether to auto accept request to join leave. | |
Description | String | The description of the role assigned member. | |
OnlyAllowMembersViewMembership | Boolean | A boolean indicating whether to only allow members view membership. | |
OwnerTitle | String | The owner title of the role assigned member. | |
RequestToJoinLeaveEmailSetting | String | The request to join leave email setting of the role assigned member. | |
PrincipalId | String |
RoleAssignments.PrincipalId | The Principal Id. |
List | String |
Lists.Title | The internal name of the list to retrieve role assigned member from. |
ItemId | String | List item id for role assignment. |
Get Web RoleAssignments.
SELECT * FROM RoleAssignments WHERE List = 'TestApp' SELECT * FROM RoleAssignments WHERE PrincipalId = 5 AND list = 'KatsunariMatsumoto' AND ItemId = '3'
Name | Type | References | Description |
ID [KEY] | String | The ID of the role assigned. | |
PrincipalId | Long | The Principal ID for role assigned. | |
Updated | Datetime | The updated date for role assigned. | |
List | String |
Lists.Title | The internal name of the list to retrieve role assigned from. |
ItemId | String | List item id for role assignment. |
Get Web Role definition binding.
NOTE: PrincipalId is required to return RoleDefinitionBindings.
SELECT * FROM RoleDefinitionBindings WHERE PrincipalId = 3 SELECT * FROM RoleDefinitionBindings WHERE List = 'TestApp' AND PrincipalId = 3 SELECT * FROM RoleDefinitionBindings WHERE PrincipalId = 5 AND list = 'KatsunariMatsumoto' AND ItemId = '3'
Name | Type | References | Description |
ID [KEY] | String | The ID of the role assigned member. | |
BasePermissions_High | Int64 | The base permissions high. | |
BasePermissions_Low | Int64 | The base permissions low. | |
Description | String | The description. | |
Hidden | Boolean | A boolean indicating if it is hidden. | |
Name | String | The name. | |
Order | Int | The order. | |
RoleTypeKind | Int | The role type kind. | |
PrincipalId | String |
RoleAssignments.PrincipalId | The Principal Id. |
List | String |
Lists.Title | The internal name of the list to retrieve role assigned member from. |
ItemId | String | List item id for role defintion. |
Query the roles your users can have.
Name | Type | References | Description |
Id [KEY] | Int | ||
BasePermissions_High | Long | ||
BasePermissions_Low | Long | ||
Description | String | ||
Hidden | Bool | ||
Name | String | ||
Order | Int | ||
RoleTypeKind | Int |
This lists the available subsites.
SELECT * FROM Subsites
Name | Type | References | Description |
Id [KEY] | String | The Id of the subsite. | |
AllowRssFeeds | Boolean | The AllowRssFeeds of the subsite. | |
AlternateCssUrl | String | The AlternateCssUrl of the subsite. | |
AppInstanceId | String | The AppInstanceId of the subsite. | |
ClassicWelcomePage | String | The ClassicWelcomePage of the subsite. | |
Configuration | Int | The Configuration of the subsite. | |
Created | Datetime | The Created of the subsite. | |
CurrentChangeToken_StringValue | String | The CurrentChangeToken_StringValue of the subsite. | |
CustomMasterUrl | String | The CustomMasterUrl of the subsite. | |
Description | String | The Description of the subsite. | |
DesignPackageId | String | The DesignPackageId of the subsite. | |
DocumentLibraryCalloutOfficeWebAppPreviewersDisabled | Boolean | The DocumentLibraryCalloutOfficeWebAppPreviewersDisabled of the subsite. | |
EnableMinimalDownload | Boolean | The EnableMinimalDownload of the subsite. | |
FooterEmphasis | Int | The FooterEmphasis of the subsite. | |
FooterEnabled | Boolean | The FooterEnabled of the subsite. | |
FooterLayout | Int | The FooterLayout of the subsite. | |
HeaderEmphasis | Int | The HeaderEmphasis of the subsite. | |
HeaderLayout | Int | The HeaderLayout of the subsite. | |
HideTitleInHeader | Boolean | The HideTitleInHeader of the subsite. | |
HorizontalQuickLaunch | Boolean | The HorizontalQuickLaunch of the subsite. | |
IsHomepageModernized | Boolean | The IsHomepageModernized of the subsite. | |
IsMultilingual | Boolean | The IsMultilingual of the subsite. | |
IsRevertHomepageLinkHidden | Boolean | The IsRevertHomepageLinkHidden of the subsite. | |
KeepFieldUserResources | Boolean | The KeepFieldUserResources of the subsite. | |
Language | Int | The Language of the subsite. | |
LastItemModifiedDate | Datetime | The LastItemModifiedDate of the subsite. | |
LastItemUserModifiedDate | Datetime | The LastItemUserModifiedDate of the subsite. | |
LogoAlignment | Int | The LogoAlignment of the subsite. | |
MasterUrl | String | The MasterUrl of the subsite. | |
MegaMenuEnabled | Boolean | The MegaMenuEnabled of the subsite. | |
NavAudienceTargetingEnabled | Boolean | The NavAudienceTargetingEnabled of the subsite. | |
NoCrawl | Boolean | The NoCrawl of the subsite. | |
ObjectCacheEnabled | Boolean | The ObjectCacheEnabled of the subsite. | |
OverwriteTranslationsOnChange | Boolean | The OverwriteTranslationsOnChange of the subsite. | |
ResourcePath_DecodedUrl | String | The ResourcePath_DecodedUrl of the subsite. | |
QuickLaunchEnabled | Boolean | The QuickLaunchEnabled of the subsite. | |
RecycleBinEnabled | Boolean | The RecycleBinEnabled of the subsite. | |
SearchScope | Int | The SearchScope of the subsite. | |
ServerRelativeUrl | String | The ServerRelativeUrl of the subsite. | |
SiteLogoUrl | String | The SiteLogoUrl of the subsite. | |
SyndicationEnabled | Boolean | The SyndicationEnabled of the subsite. | |
TenantAdminMembersCanShare | Int | The TenantAdminMembersCanShare of the subsite. | |
Title | String | The Title of the subsite. | |
TreeViewEnabled | Boolean | The TreeViewEnabled of the subsite. | |
UIVersion | Int | The UIVersion of the subsite. | |
UIVersionConfigurationEnabled | Boolean | The UIVersionConfigurationEnabled of the subsite. | |
Url | String | The Url of the subsite. | |
WebTemplate | String | The WebTemplate of the subsite. | |
WelcomePage | String | The WelcomePage of the subsite. |
Query the available users on your sharepoint site.
SELECT * FROM Users // Fetch all the Users SELECT * FROM Users WHERE GroupId = 5 // Fetch a user for a particular Group
Name | Type | References | Description |
AadObjectId_NameId | String | ||
AadObjectId_NameIdIssuer | String | ||
String | |||
Expiration | String | ||
IsEmailAuthenticationGuestUser | Bool | ||
IsShareByEmailGuestUser | Bool | ||
IsSiteAdmin | Bool | ||
UserId_NameId | String | ||
UserId_NameIdIssuer | String | ||
UserPrincipalName | String | ||
LinkedAlerts | String | ||
LinkedGroups | String | ||
LoginName | String | The login name of the user. | |
Title | String | The Title of the user. | |
IsHiddenInUI | Boolean | A boolean indicating if the user is hidden in UI. | |
GroupId | Int | The group id the user is added to. |
ストアドプロシージャはファンクションライクなインターフェースで、Microsoft SharePoint の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにMicrosoft SharePoint から関連するレスポンスデータを返します。
Name | Description |
AddAttachment | SharePoint リストに添付ファイルを追加します。 |
CheckInDocument | 特定のドキュメントをドキュメントライブラリにチェックインします。 |
CheckOutDocument | ドキュメントライブラリ内の特定のドキュメントをチェックアウトします。 |
CopyDocument | Copies the file to the destination URL.. |
CreateFolder | SharePointサイトのドキュメントライブラリにフォルダを追加します。 |
DeleteAttachment | Deletes an attachment from Sharepoint list. |
DeleteDocument | Deletes a Document from the SharePoint document library. |
DiscardCheckOutDocument | Reverts an existing checkout for the file. |
GetAdminConsentURL | アプリケーションへのアクセスを許可するために、ドメイン管理者が個別に開く必要がある、管理者の同意のURL を取得します。カスタムOAuth 資格情報を使用している場合のみ必要です。 |
GetCurrentUser | 現在ログインしているユーザーの情報を取得します。 |
MoveAttachmentOrDocument | Moves a document or attachment from a source folder to a destination folder. |
RenameAttachmentOrDocument | Renames a document or attachment. |
SharePoint リストに添付ファイルを追加します。
Name | Type | Description |
ListTitle | String | リストアイテムのタイトル。 |
ItemId | String | リストアイテムのId。 |
FileName | String | ドキュメントライブラリに追加するファイル名。 |
InputFilePath | String | ファイルを添付する場所。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
RelativeUrl | String | 追加された添付ファイルの相対URL。 |
特定のドキュメントをドキュメントライブラリにチェックインします。
Name | Type | Description |
RelativeURL | String | フォルダの相対URL。 |
DocumentName | String | チェックインするファイル名。 |
Comment | String | ドキュメントをチェックインする際の任意のメッセージ。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
ドキュメントライブラリ内の特定のドキュメントをチェックアウトします。
Name | Type | Description |
RelativeURL | String | フォルダの相対URL。 |
DocumentName | String | チェックインするファイル名。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
Copies the file to the destination URL..
Name | Type | Description |
SourceFileRelativeUrl | String | The relative URL of the source file. |
DestFileRelativeUrl | String | The relative URL of the destination file. |
Name | Type | Description |
Success | Boolean | Indicates whether the operation was successful or not. |
SharePointサイトのドキュメントライブラリにフォルダを追加します。
Name | Type | Description |
RelativeURL | String | フォルダの相対URL。 |
FolderName | String | 作成するフォルダ名。 |
Name | Type | Description |
Success | Boolean | 操作が成功したかどうかを示します。 |
Id | String | 操作の完了後に返される一意の識別子の値. |
Deletes an attachment from Sharepoint list.
Name | Type | Description |
ListTitle | String | The Title of the list item. |
ItemId | String | The Id of the list item. |
FileName | String | The name of the file to be added to the document library |
Name | Type | Description |
Success | Boolean | Indicates whether the operation was successful or not. |
Deletes a Document from the SharePoint document library.
Name | Type | Description |
RelativePath | String | The path of the document you want to delete relative to the URL specified in the connection property. For example: '/Shared Documents/My Folder/My Document.txt'. |
Permanently | Boolean | Whether to delete the document permanently or just move it to the recycle bin. Default behavior is to move it to the recycle bin.
デフォルト値はfalseです。 |
Name | Type | Description |
Success | Boolean | Indicates whether the operation was successful or not. |
ErrorCode | Integer | The error code in case the procedure is not executed successfully. |
ErrorMessage | String | The error message in case the procedure is not executed successfully. |
Reverts an existing checkout for the file.
Name | Type | Description |
RelativeURL | String | The relative URL of the folder. |
DocumentName | String | The name of the file to be checked in. |
Name | Type | Description |
Success | Boolean | Indicates whether the operation was successful or not. |
アプリケーションへのアクセスを許可するために、ドメイン管理者が個別に開く必要がある、管理者の同意のURL を取得します。カスタムOAuth 資格情報を使用している場合のみ必要です。
Name | Type | Description |
CallbackUrl | String | アプリケーションが認可された後にユーザーがリダイレクトされるURL。この値は、Azure AD アプリ設定内のリダイレクトURL に合致する必要があります。 |
State | String | 認証コードをリクエストしたときに送信した状態と同じ値。 |
Scope | String | 管理者にリクエストしているスコープまたは権限。
デフォルト値はAllSites.Manageです。 |
Name | Type | Description |
URL | String | ベリファイアトークンを取得してアプリを認可するためにWeb ブラウザに入力される、認可URL。 |
現在ログインしているユーザーの情報を取得します。
Name | Type | Description |
Id | Int | ユーザーId。 |
Title | String | ユーザーの役職。 |
String | ユーザーの電子メール。 | |
IsSiteAdmin | Boolean | ユーザーがサイト管理者かどうか。 |
Moves a document or attachment from a source folder to a destination folder.
The MoveAttachmentOrDocument stored procedure requires the SourceFileURL and DestinationFolderURL parameters to move an attachment or document.
For Example,
EXEC MoveAttachmentOrDocument SourceFileURL = '/Shared Documents/Dummy.txt', DestinationFolderURL = '/Shared Documents/MySite'
Name | Type | Description |
SourceFileURL | String | The URL of the source file, relative to the base Url supplied in the Cloud's connection properties. For example: Root Directory file: /Shared Documents/filename.txt Sub-directory file:/Shared Documents/MyFolder/filename.txt If you set the Url connection property to a site collection, the relative URL corresponds with a path on the base site. If the Url connection property points to a specific site, the relative URL is relative to the site supplied in the Url. |
DestinationFolderURL | String | URL of the destination folder where you want to move the file ,relative to the base Url supplied in the Cloud's connection properties. For example: Root Directory: /Shared Documents/ Sub-directory:/Shared Documents/MyFolder/ If you set the Url connection property to a site collection, the relative URL corresponds to a path on the base site. If the Url connection property points to a specific site, the relative URL is relative to the site supplied in the Url. |
Name | Type | Description |
Success | Boolean | Indicates whether the operation was successful or not. |
Renames a document or attachment.
The RenameAttachmentOrDocument stored procedure requires the SourceFileURL and NewFileName parameters to rename an attachment or document.
For Example:
EXEC RenameAttachmentOrDocument SourceFileURL = '/Shared Documents/Dummy.txt', NewFileName = 'Dummy1.txt'
Name | Type | Description |
SourceFileURL | String | The URL of the file you want to rename, relative to the base Url supplied in the Cloud's connection properties. For example: Root Directory file: /Shared Documents/filename.txt Sub-directory file:/Shared Documents/MyFolder/filename.txt If you set the Url connection property to a site collection, the relative URL corresponds to a path on the base site. If the Url connection property points to a specific site, the relative URL is relative to the site supplied in the Url. |
NewFileName | String | The new name of the file, with extension. |
Name | Type | Description |
Success | Boolean | Indicates whether the operation was successful or not. |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、Microsoft SharePoint のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリ(バッチ処理を含む)のクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
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 | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Calendar テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Calendar'
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 などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、ListItems ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName='ListItems' 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 | パラメータのインデックス。 |
主キーおよび外部キーについて説明します。
次のクエリは、Calendar テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Calendar'
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:sharepoint: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 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、SOAP データモデル セクションを参照してください。
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、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
Cloud は、データソースの型を、スキーマで使用可能な対応するデータ型にマッピングします。以下のテーブルはこれらのマッピングを説明します。
Microsoft SharePoint | CData Schema |
Choice (menu) | string |
Currency | float |
Date and Time | datetime |
Hyperlink or Picture | string |
Lookup | string |
Multiple lines of text | string |
Number | float |
Person or Group | string |
Single line of text | string |
Task Outcome | string |
Yes/No | bool |
プロパティ | 説明 |
AuthScheme | SharePoint への認証に使用されるスキーム。 |
URL | サイトのベースURL。 |
SharePointEdition | 使用されているSharePoint のエディション。SharePoint Online またはSharePoint On-Premise のいずれかを設定します。 |
User | 認証で使用されるSharePoint ユーザーアカウント。 |
Password | ユーザーの認証で使用されるパスワード。 |
プロパティ | 説明 |
AzureTenant | データにアクセスするために使用されるMicrosoft Online テナント。指定しない場合は、デフォルトのテナントが使用されます。 |
AzureEnvironment | 接続を確立するときに使用するAzure 環境。 |
プロパティ | 説明 |
SSOLoginURL | ID プロバイダーのログインURL。 |
SSODomain | シングルサインオン(SSO)を使用する場合のユーザーのドメイン。 |
SSOProperties | セミコロンで区切られたID プロバイダーへの接続に必要な追加プロパティ。 |
プロパティ | 説明 |
OAuthClientId | OAuth 認証サーバーを使用してアプリケーションを登録する場合に割り当てられたクライアントId。 |
OAuthClientSecret | OAuth 認証サーバーにアプリケーションを登録する場合に割り当てられたクライアントシークレット。 |
Scope | The scope used for the OAuth flow to access data from the Application. |
State | 追加のOAuth ステート情報を表すオプションの値。 |
OAuthGrantType | OAuth フローのグラント種別。 |
プロパティ | 説明 |
OAuthJWTCert | JWT 証明書のストア。 |
OAuthJWTCertType | JWT 証明書を格納するキーストアの種類。 |
OAuthJWTCertPassword | OAuth JWT 証明書のパスワード。 |
OAuthJWTIssuer | Java Web Token の発行者。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Schema | 使用するスキーマの種類。 |
プロパティ | 説明 |
CalculatedDataType | 計算フィールドで使用されるデータ型。 |
ContinueOnError | エラー後にバッチ内の項目の更新を続行するかどうかを示します。 |
CreateIDColumns | 他のリストに格納されている情報からの値を使っているSharePoint 列に補助的ID 列を作成するかしないかを示します。 |
DisableFilterLimit | Microsoft SharePoint natively supports listing up to 5000 records as they appear in your list filter. Enable this property to pull more than 5000 records from the list filter at the cost of additional performance overhead. |
FolderOption | 結果にフォルダを表示する方法を決定するオプション。FilesOnly、FilesAndFolders、Recursive、RecursiveAll のいずれかを入力します。 |
IncludeLookupColumns | このオプションは、ドライバーがテーブルで定義されたルックアップ列を返すかどうかを設定します。 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
Pagesize | Microsoft SharePoint から返されるページあたりの結果の最大数。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
ShowHiddenColumns | 非表示の列を表示するかどうかを決定するboolean。false の場合は、すべての非表示の列が列リストから削除されます。 |
ShowPredefinedColumns | 定義済みの列を表示するかどうかを決定するboolean。false の場合は、基本型から派生されたすべての列が列リストから削除されます。 |
ShowVersionViews | リストバージョンのビューを表示するかどうかを指定します。例:ListA_Versions など。 |
STSURL | シングルサインオン(SSO)を使用する場合のセキュリティトークンサービス(STS)のURL。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UseDisplayNames | API 名の代わりにカラムの表示名を使用するかどうかを決定するboolean。 |
UseEntityTypeName | Boolean determining if the table name should be EntityTypeName instead of the title in the REST schema. |
UseNTLMV1 | ドライバーが、NTLMv1 かNTLMv2(デフォルト)のどちらで接続するかを決定します。 |
UseSimpleNames | テーブルとカラムに簡略名を使用するかどうかを決定するboolean。 |