はじめに

このページでは、CData Cloud でのLDAP への接続の確立のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

LDAP への接続

接続の確立は、CData Cloud にデータベースを作成するためのLDAP への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してLDAP からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメントで詳しく説明します。

接続の確立

Database タブで対応するアイコンを選択して、LDAP に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

LDAP への接続

CData driver for LDAP は、LDAP サーバーオブジェクトへの接続をサポートします。接続するには必要なプロパティを設定します。

必須プロパティ

Server：LDAP サーバーのドメイン名、もしくはIP。
Port：The port setting defaults to port=389.Specifying the port to a different setting is optional.
BaseDN：このプロパティは、結果を指定されたサブツリーに限定するために使用されます。BaseDN（Base Distinguished Name）の範囲を絞ることはパフォーマンスを劇的に向上させます。例えば、cn=users,dc=domain の値は、cn=users およびその子に含まれる結果のみを返します。

オプションのプロパティ

Optional properties can be used to further refine control of the returned results.

FollowReferrals：This property follows referrals when TRUE.The returned response then becomes read only.To modify data returned by a referral server, open a new connection to the server by specifying server and port.
Scope：This property enables more control over the search depth of the LDAP tree, starting with BaseDN.範囲を限定することで、検索パフォーマンスを大幅に向上させられます。Scope を次の値のいずれかに指定します：
- WholeSubtree：検索の範囲を、BaseDN およびすべての子階層に制限します。
- SingleLevel：検索の範囲を、BaseDN および1つ下の子階層に制限します。
- BaseObject：検索の範囲を、ベースオブジェクトのみに制限します。
LDAPVersion：サーバーに接続し、通信する際に使われるLDAP バージョン。2 に設定します。

LDAP への認証

リクエストを認証するには、User およびPassword プロパティを有効なLDAP クレデンシャルに設定します。例えば、User をDomain\\BobF またはcn=Bob F,ou=Employees,dc=Domain に設定します。

The AuthMechanism properties for the Cloud are as follows:

SIMPLE：The default plaintext value of the authentication mechanism to login to the server.
NEGOTIATE：Negotiates whether to use NTLN or Kerberos when authenticating to the server.

SSL Configuration

By default, the driver uses plaintext when communicating with the server set to port=389. The driver automatically switches to use SSL when talking to the LDAP on port=636. You can force the connection to use the SSL connection property when set to SSL=TRUE.

テーブルのカスタマイズ

Cloud は、LDAP エンティティから最も頻繁に必要とされるカラムを表示します。ただし、その他のデータを使用する必要がある場合は、テーブルを簡単に変更できます。テーブルは、シンプルな形式のスキーマファイルで定義されます。

デフォルトのスキーマを拡張する方法や独自のスキーマを記述する方法については、LDAP テーブルとの連携を参照してください。カスタムスキーマを使用するには、Location プロパティをスキーマファイルを有するフォルダに設定します。テーブルおよびビューについて詳しくは、サンプルデータモデルを参照してください。

LDAP テーブルとの連携

LDAP オブジェクトクラスへのテーブルスキーマのマッピングを定義する。

このセクションでは、Person.rsd ファイルを使ってCData Cloud において希望するオブジェクトクラスの新テーブルを作成する方法を説明します。Person.rsd は、Cloud のインストールフォルダのdb サブフォルダに格納されています。

カスタムスキーマを使用するには、Location プロパティをスキーマファイルを有するフォルダに設定します。スキーマを.rsd ファイルで定義する。

新しいテーブルを定義する

新しいテーブルを、そのテーブルが表すオブジェクトクラスと同じ名前に定義することは大切です。これにより、Cloud はLDAP サーバーをクエリする際に、ターゲットのオブジェクトクラスのみを検索します。

rsb:info エレメントでテーブル名を定義する。次の例では、Person.rsd のテーブル名およびカラムの定義について説明します：

<rsb:script xmlns:rsb="http://www.rssbus.com/ns/rsbscript/2">

  <rsb:info title="Person" description="Create, update, delete, and query person entries in LDAP.">
    <!-- Required Columns -->
    <attr name="Id"              xs:type="string"  readonly="true"  key="true"       desc="The index of the row, when 'splitDataByRow' is set for a column, combined with the full distinguished name." />
    ...

テーブルカラムおよびインプット

スキーマ内の"attr" タグは、テーブルのカラムを表します。これらは、希望するオブジェクトクラスを構成するアトリビュートに合致するはずです。

まず、オブジェクトクラスに関係なく、すべてのテーブルに含まれるカラムがあります：

    <!-- Required Columns -->
    <attr name="Id"          xs:type="string" readonly="true"  key="true"       desc="The index of the row, when 'splitDataByRow' is set for a column, combined with the full distinguished name." />
    <attr name="DN"          xs:type="string" readonly="true"  required="false" other:ldaptype="OID"               desc="The full distinguished name." />
    <attr name="RDN"         xs:type="string" readonly="true"  required="false" other:ldaptype="Directory String"  desc="The relative distinguished name."/>
    <attr name="BaseDN"      xs:type="string" readonly="true"  required="false" other:ldaptype="OID"               desc="The base distinguished name." />

必須カラムに加えて、希望するオブジェクトクラスからのアトリビュートが指定される必要があります。追加で、データがテーブルからどのように返されるかを規定するdataFormat を指定する必要があります。次に例を示します。

    <!-- Person Required Attributes -->
    <attr name="ObjectClass"                 other:dataFormat="splitDataByRow" xs:type="string" readonly="false" required="false"  other:ldaptype="OID" desc="The object class of the entry."/>
    <attr name="SN"                          other:dataFormat="delimitedData"  xs:type="string" readonly="false" required="false"  other:ldaptype="Directory String"           desc="The required attribute SN for the user object class."/>
    <attr name="CN"                          other:dataFormat="delimitedData"  xs:type="string" readonly="false" required="false"  other:ldaptype="Directory String"           desc="The required attribute CN for the user object class."/>

    <!-- Person Optional Attributes -->
    <attr name="UserPassword"                other:dataFormat="delimitedData"  xs:type="string" readonly="false" required="false"  other:ldaptype="Binary"                     desc="The optional attribute UserPassword for the user object class."/>
    <attr name="TelephoneNumber"             other:dataFormat="delimitedData"  xs:type="string" readonly="false" required="false"  other:ldaptype="Directory String"           desc="The optional attribute TelephoneNumber for the user object class."/>
    <attr name="SeeAlso"                     other:dataFormat="delimitedData"  xs:type="string" readonly="false" required="false"  other:ldaptype="DN"                         desc="The optional attribute SeeAlso for the user object class."/>
    <attr name="Description_1"               other:dataFormat="splitDataByCol" xs:type="string" readonly="false" required="false"  other:ldaptype="Directory String"           desc="The optional attribute Description for the user object class."/>
    <attr name="Description_2"               other:dataFormat="splitDataByCol" xs:type="string" readonly="false" required="false"  other:ldaptype="Directory String"           desc="The optional attribute Description for the user object class."/>
    <attr name="Description_3"               other:dataFormat="splitDataByCol" xs:type="string" readonly="false" required="false"  other:ldaptype="Directory String"           desc="The optional attribute Description for the user object class."/>

The other: dataFormat には3つのオプションがあります：


delimitedData	Table Setting にて定義された"区切り" により区切られた文字列として、複数のアトリビュートを返します。（デフォルトはセミコロンです。）
splitDataByRow	同じDN に対する複数のアトリビュート値は、別々の行として扱われます。他のすべてのカラムはそのままプッシュされ、Id のインデックスは増分されます。（このように複数のカラムをプッシュすることは、結果セットを大きくしてパフォーマンスの問題を引き起こす可能性があります。）
splitDataByCol	同じDN に対する複数のアトリビュート値は、カラム名の付属インデックスとともにプッシュされます。複数のカラムを定義して終わりに"_n" を付ける必要があります。例えば、ObjectClass_1、ObjectClass_2、ObjectClass_3 のようにします。このサンプルでは、3つを超える値がある場合、カラムが追加されない限り、テーブルでは残りの値は表示されません。

例えば、次のコードはObjectClass アトリビュートの異なる値をそれぞれの行に分割して、Description をそれぞれのカラムにします。カラム定義には、Description アトリビュートの複数のカラムが含まれることに注意してください。<attr> に対する、other dataFormat アトリビュートにも注意してください。

    ...
    <attr name="ObjectClass"     other:dataFormat="delimitedData" xs:type="string"  readonly="false" required="false" other:ldaptype="OID" desc="The object class of the entry."/>
    <attr name="SN"              other:dataFormat="delimitedData" xs:type="string"  readonly="false" required="false" other:ldaptype="Directory String"           desc="The surname of the person."/> 
    <attr name="CN"              other:dataFormat="delimitedData" xs:type="string"  readonly="false" required="false" other:ldaptype="Directory String"           desc="The common name of the person."/> 
    <attr name="UserPassword"    other:dataFormat="delimitedData" xs:type="string"  readonly="false" required="false" other:ldaptype="Binary"                     desc="The user password of the person."/>
    <attr name="TelephoneNumber" other:dataFormat="delimitedData" xs:type="string"  readonly="false" required="false" other:ldaptype="Directory String"           desc="The telephone number of the person."/>
    <attr name="SeeAlso"         other:dataFormat="delimitedData" xs:type="string"  readonly="false" required="false" other:ldaptype="DN"                         desc="The see-also distinguished name of the person."/>
    <attr name="Description_1"   other:dataFormat="delimitedData" xs:type="string"  readonly="false" required="false" other:ldaptype="Directory String"           desc="The description of the person."/>
    <attr name="Description_2"   other:dataFormat="delimitedData" xs:type="string"  readonly="false" required="false" other:ldaptype="Directory String"           desc="The description of the person."/>
    <attr name="Description_3"   other:dataFormat="delimitedData" xs:type="string"  readonly="false" required="false" other:ldaptype="Directory String"           desc="The description of the person."/>
    
  </rsb:info>
  
  <!-- Table Settings -->
  <rsb:set attr="delimiter" value=";"/>
  ...

サンプルの結果はこのようになります：


Id	DN	ObjectClass	SN	CN	UserPassword	TelephoneNumber	SeeAlso	Description_1	Description_2	Description_3
1\|CN=User1,DC=Test	CN=User1,DC=Test	Top	TestSN	User1		555-5555	A;B;C	Desc1	Desc2	Desc3
2\|CN=User1,DC=Test	CN=User1,DC=Test	User	TestSN	User1		555-5555	A;B;C	Desc1	Desc2	Desc3

Note：デフォルトで、データはdelimitedData として返されます。

インプットのデータ形式に加え、エンコードも指定が可能です。現在、UTF8 エンコード、もしくはBASE64 エンコードでのデータの戻りがサポートされています。特定のエンコードでデータを取得したい場合には、'other:encoding' フィールドを、使いたいエンコードのアトリビュートに指定する必要があります。エンコードの指定がない場合、UTF8 がデフォルトです。

アトリビュートのエンコード指定の例：

    ...
    <attr name="ObjectClass"     other:dataFormat="delimitedData" other:encoding="UTF8"   xs:type="string"  readonly="false" required="false" other:ldaptype="OID"               desc="The object class of the entry."/>
    <attr name="SN"              other:dataFormat="delimitedData" other:encoding="BASE64" xs:type="string"  readonly="false" required="false" other:ldaptype="Directory String"  desc="The surname of the person."/> 
    ...

テーブル設定

アトリビュートおよびインプットに加えて、区切り記号を指定する必要があります。

区切り記号（Delimiter）は、区切りデータで使われる文字です。区切りデータは、一つのオブジェクトに複数回出現するアトリビュートすべてにおいて返されます（他のdataFormat に指定されている場合を除いて）。

例えば、下のコードは';' 記号を使って、アトリビュートの複数の値をコンカテネイトします。

    ...
  </rsb:info>  
    
  <!-- Table Settings -->
  <rsb:set attr="delimiter" value=";"/>
  ...

オペレーション定義

オペレーション定義は、すべての新たに作られたテーブルにおいてそのまま維持されます。既存テーブルからコピー＆ペーストしてください。

  <!-- Operation definitions -->
  <rsb:script method="GET">
    <rsb:set attr="action" value="Get" />
    <rsb:call op="ldapadoLDAP" >
      <rsb:push />
    </rsb:call>
  </rsb:script>

  <rsb:script method="POST">
    <rsb:set attr="action" value="Post" />
    <rsb:call op="ldapadoLDAP" >
      <rsb:push item="toout"/>
    </rsb:call>
  </rsb:script>

  <rsb:script method="MERGE">
    <rsb:set attr="action" value="Merge" />
    <rsb:call op="ldapadoLDAP" >
      <rsb:push />
    </rsb:call>
  </rsb:script>

  <rsb:script method="DELETE">
    <rsb:set attr="action" value="Delete" />
    <rsb:call op="ldapadoLDAP" >
      <rsb:push />
    </rsb:call>
  </rsb:script>

SSL の設定

SSL 設定のカスタマイズ

To enable TLS, set the following:

UseSSL: True
Port: 636

With this configuration, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

次のプロパティを設定します。

プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
接続をトンネルするには、FirewallType をTUNNEL に設定します。
認証するには、FirewallUser とFirewallPassword を設定します。
SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

サンプルデータモデル

CData Cloud はLDAP データを使いやすいSQL データベースとしてモデル化します。また、Cloud の機能性を拡張するストアドプロシージャも含まれます。

テーブル

付属のテーブルは多くの標準オブジェクトクラスをカバーしており、LDAP ディレクトリエントリの構造とルールを定義しています。簡単な設定ファイルを変更するだけで、テーブルスキーマを簡単に拡張してLDAP クラスにさらに密接にマッピングできます。テーブルスキーマをカスタマイズする方法については、LDAP テーブルとの連携を参照してください。

Note：カスタムテーブルおよびカスタムスキーマを使用するには、Location プロパティをスキーマファイルを有するフォルダに設定します。

以下のテーブルはCloud に同梱されています。


テーブル	説明
Group	組織リソースへのアクセスとセキュリティのロールを管理するためのユーザーの識別名（DN）の一覧を保存します。
OrganizationalPerson	社員番号、部署、マネージャー、役職、勤務先住所など、ユーザーに関する組織の詳細情報を含んでいます。このクラスは、ディレクトリ情報システムで一般的に使用されています。
Person	ユーザーに関する個人情報を保存します。氏名や連絡先などの一般的な詳細情報を含みます。
Top	他のすべてのLDAP クラスが派生するルートクラス。他のディレクトリクラスに基本的な属性を提供します。
User	組織内の従業員、契約社員、または長期訪問者に関する情報を保存します。氏名、連絡先、職務関連情報などの属性を含みます。

ストアドプロシージャ

ストアドプロシージャは、SQLクエリを介して呼び出されるスクリプトです。標準のCRUD 操作を超えたタスクを実行し、LDAP レポートをテーブルとして表示したり、添付ファイルを作成したりできます。

テーブル

Cloud はLDAP のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - LDAP テーブル


Name	Description
Group	Stores a list of user Distinguished Names (DNs) for managing access and security roles on organizational resources.
OrganizationalPerson	Contains organizational details about a user, such as employee number, department, manager, job title, office address, and more. This class is commonly used for directory information systems.
Person	Stores personal information about a user, including general details such as name and contact information.
Top	The root class from which all other LDAP classes are derived. It provides foundational attributes for other directory classes.
User	Stores information about employees, contractors, or long-term visitors in an organization. Includes attributes such as name, contact details, and job-related information.

Group

Stores a list of user Distinguished Names (DNs) for managing access and security roles on organizational resources.

テーブル固有の情報

Select

すべてのカラムは、演算子=、>=、<=、!=、LIKE、AND、およびOR のサーバー側の処理をサポートします。その他のフィルタはCloud 内でクライアント側で実行されます。例えば、次のクエリはLDAP によって処理されます。

SELECT * FROM Group WHERE  GroupType != '-2147483644' AND  ObjectClass = 'top;group' LIMIT 5

Insert

Group を追加するには、Id、DN、およびBaseDN 以外のすべてのフィールドを指定できます。必須のフィールドはRDN とObjectClass です。次に例を示します。

INSERT INTO Group (RDN, ObjectClass) VALUES ('CN=Domain Admins', 'group')

Update

Id、DN、およびBaseDN 以外のすべてのカラムは、WHERE 句にId を指定することで更新できます。次に例を示します。

UPDATE Group SET Member = 'CN=SUPPORT_388945a0,CN=Users,DC=MyDC' WHERE Id = '1|CN=HelpServicesGroup,CN=Users,DC=MyDC'

Delete

DELETE ステートメントにGroup のId を指定することで、グループを削除できます。次に例を示します。

 DELETE FROM Group WHERE Id = '1|CN=HelpServicesGroup,CN=Users,DC=MyDC'

Columns


Name	Type	ReadOnly	References	DataFormat	Description
Id [KEY]	String	True			A combined index and Distinguished Name (DN) uniquely identifying the group. Multiple indices are supported if the column is set to 'SplitDataByRow'.
DN	String	True			The full Distinguished Name (DN) that uniquely identifies the group in the LDAP directory.
RDN	String	False			The Relative Distinguished Name (RDN), representing the unique portion of the DN within its parent container.
BaseDN	String	True			The base Distinguished Name (BaseDN) indicating the starting point for LDAP operations related to the group.
GroupType	String	False		DelimitedData	A set of flags that define the type and scope of the group object, such as whether it is a security or distribution group. Refer to LDAP documentation for possible values.
ObjectClass	String	False		SplitDataByRow	A list of LDAP object classes from which the group is derived, defining its attributes and behavior.
Member	String	False		DelimitedData	A list of Distinguished Names (DNs) representing users or other groups that are members of this group.
NTGroupMembers	String	False		DelimitedData	An unused attribute related to legacy Windows NT group membership functionality.
OperatorCount	String	False		DelimitedData	Tracks the number of operators assigned to this group for administrative purposes.
AdminCount	String	False		DelimitedData	Indicates whether the object's Access Control Lists (ACLs) have been adjusted for higher security due to membership in an administrative group.
GroupAttributes	String	False		DelimitedData	An unused attribute associated with additional group-specific attributes.
GroupMembershipSAM	String	False		DelimitedData	Provides support for down-level Windows NT group membership functionality.
ControlAccessRights	String	False		DelimitedData	Specifies the access control rights for determining which users can perform specific operations on the group.
DesktopProfile	String	False		DelimitedData	Specifies the location of the desktop profile for a user or group of users. This attribute is no longer in use.
NonSecurityMember	String	False		DelimitedData	Specifies non-security members of the group, often used for Exchange distribution lists.
ManagedBy	String	False		DelimitedData	The Distinguished Name (DN) of the user assigned as the manager of this group object.
PrimaryGroupToken	String	False		DelimitedData	A computed attribute used to retrieve the membership list of certain groups, such as Domain Users. Membership lists are not explicitly stored for scalability.
Mail	String	False		DelimitedData	A list of email addresses associated with the group or its members.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
Filter	String	Defines an explicit LDAP filter that overrides other filter values set in the WHERE clause of the query.

OrganizationalPerson

Contains organizational details about a user, such as employee number, department, manager, job title, office address, and more. This class is commonly used for directory information systems.

Table Specific Information

Select

All columns support server-side processing for the operators =, >= , <=, !=, LIKE, AND, and OR. Other filters are executed client side within the Cloud. For example, the following query is processed by LDAP:

SELECT * FROM OrganizationalPerson WHERE  CN != 'NewUser' AND  BaseDN = 'CN=Users,DC=MyDC' LIMIT 5

Insert

To add a OrganizationalPerson, all fields can be specified except Id, DN, and BaseDN. Required fields that should be provided are RDN and ObjectClass. For example:

INSERT INTO OrganizationalPerson (RDN, ObjectClass) VALUES ('CN=NewUser', 'top;person;organizationalPerson;user;inetOrgPerson')

Update

All columns except Id, DN, and BaseDN can be updated by providing the Id in the WHERE clause. For example:

UPDATE OrganizationalPerson SET Description = 'desc' WHERE Id = '1|CN=NewUser,CN=Users,DC=MyDC'

Delete

OrganizationalPersons can be deleted by providing the Id of the OrganizationalPerson in a DELETE statement. For example:

DELETE FROM OrganizationalPerson WHERE Id = '1|CN=NewUser,CN=Users,DC=MyDC'

Columns


Name	Type	ReadOnly	References	DataFormat	Description
Id [KEY]	String	True			A combined index and Distinguished Name (DN). Multiple indices are allowed if the column is set to 'SplitDataByRow'.
DN	String	True			The full Distinguished Name (DN) representing the unique LDAP path of the object.
RDN	String	False			The Relative Distinguished Name (RDN), which is the unique portion of the DN within its parent container.
BaseDN	String	True			The base Distinguished Name (BaseDN) that specifies the starting point for LDAP operations.
ObjectClass	String	False		DelimitedData	The hierarchical list of LDAP object classes from which this object is derived.
SN	String	False		DelimitedData	Contains the user's surname or family name, such as 'Smith'.
CN	String	False		DelimitedData	Represents the common name of the object, used in LDAP searches. For example, 'John Doe'.
UserPassword	String	False		DelimitedData	Stores the user's password in UTF-8 format. This is a write-only attribute and cannot be retrieved for security reasons.
TelephoneNumber	String	False		DelimitedData	The primary telephone number associated with the user or object.
SeeAlso	String	False		DelimitedData	A list of Distinguished Names (DNs) that are related or linked to this object.
Description	String	False		DelimitedData	Contains a textual description of the object. It is typically single-valued but may be multi-valued depending on LDAP schema settings.
Title	String	False		DelimitedData	The user's formal job title, such as 'Senior Programmer', rather than occupational class, such as programmer. It does not include suffix titles like 'Esq.' or 'DDS'.
X121Address	String	False		DelimitedData	Specifies the X.121 address associated with the object, often used in telecommunications.
RegisteredAddress	String	False		DelimitedData	A mnemonic address associated with the object, registered in the relevant country or region for Public Telegram Service.
DestinationIndicator	String	False		DelimitedData	Part of the X.500 specification but not used in NTDS.
PreferredDeliveryMethod	String	False		DelimitedData	Defines the preferred method of delivery for communication with this object, as specified by the X.500 standard.
TelexNumber	String	False		DelimitedData	A list of alternate telex numbers associated with the object.
TeletexTerminalIdentifier	String	False		DelimitedData	Specifies the Teletex terminal identifier and optional parameters for a teletex terminal linked to the object.
InternationalISDNNumber	String	False		DelimitedData	Specifies an International ISDN (Integrated Services Digital Network) number associated with the object.
FacsimileTelephoneNumber	String	False		DelimitedData	Contains the fax machine telephone number associated with the user or organization.
Street	String	False		DelimitedData	Specifies the street address for the user or object.
PostOfficeBox	String	False		DelimitedData	Specifies the post office box number associated with the object.
PostalCode	String	False		DelimitedData	The postal or ZIP code used for mail delivery to the object.
PostalAddress	String	False		DelimitedData	The complete mailing address associated with the object.
PhysicalDeliveryOfficeName	String	False		DelimitedData	Specifies the office location within the user's place of business.
OU	String	False		DelimitedData	The name of the Organizational Unit (OU) to which the object belongs.
ST	String	False		DelimitedData	The name of the state or province associated with the user or object.
L	String	False		DelimitedData	Represents the name of a locality, such as a town or city, associated with the object.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
Filter	String	Defines an explicit LDAP filter, overriding other filters defined in the WHERE clause of the query.

Person

Stores personal information about a user, including general details such as name and contact information.

Table Specific Information

Select

All columns support server-side processing for the operators =, >= , <=, !=, LIKE, AND, and OR. Other filters are executed client side within the Cloud. For example, the following query is processed by LDAP:

SELECT * FROM Person WHERE  ObjectClass = 'top' AND  CN  LIKE '%NewUser%' LIMIT 5

Insert

To add a Person, all fields can be specified except Id, DN, and BaseDN. Required fields that should be provided are RDN and ObjectClass. For example:

INSERT INTO Person (RDN, ObjectClass) VALUES ('CN=Domain Admins', 'Person')

Update

All columns except Id, DN, and BaseDN can be updated by providing the Id in the WHERE clause. For example:

UPDATE Person SET Description = 'desc' WHERE Id = '1|CN=NewUser,CN=Users,DC=MyDC'

Delete

Person rows can be deleted by providing the Id of the Person in a DELETE statement. For example:

DELETE FROM Person WHERE Id = '1|CN=NewUser,CN=Users,DC=MyDC'

Columns


Name	Type	ReadOnly	References	DataFormat	Description
Id [KEY]	String	True			A combined index and Distinguished Name (DN). Multiple indices are supported if the column is set to 'SplitDataByRow'.
DN	String	True			The full Distinguished Name (DN) representing the unique LDAP path of the object.
RDN	String	False			The Relative Distinguished Name (RDN), which is the unique part of the DN within its parent container.
BaseDN	String	True			The base Distinguished Name (BaseDN) that specifies the starting point for LDAP operations.
ObjectClass_1	String	False		SplitDataByCol	The primary object class from which this entry is derived, defining its core attributes and behavior.
ObjectClass_2	String	False		SplitDataByCol	An additional object class from which this entry inherits attributes, defining extended behavior or properties.
ObjectClass_3	String	False		SplitDataByCol	An optional object class specifying further attributes or extended functionality for the entry.
ObjectClass_4	String	False		SplitDataByCol	An optional object class specifying additional attributes or properties for the entry.
SN	String	False		DelimitedData	Contains the user's surname or family name, such as 'Smith'.
CN	String	False		DelimitedData	Represents the common name of the object, often used in LDAP searches. For example, 'John Doe'.
UserPassword	String	False		DelimitedData	Stores the user's password in UTF-8 format. This is a write-only attribute and cannot be retrieved for security purposes.
TelephoneNumber	String	False		DelimitedData	The primary telephone number associated with the user or object.
SeeAlso	String	False		SplitDataByRow	A list of Distinguished Names (DNs) related to this object, establishing references to other LDAP entries.
Description	String	False		DelimitedData	Contains a textual description of the object. Typically single-valued but can be multi-valued depending on the LDAP schema.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
Filter	String	Defines an explicit LDAP filter, overriding other filters defined in the WHERE clause of the query.

Top

The root class from which all other LDAP classes are derived. It provides foundational attributes for other directory classes.

Table Specific Information

Select

All columns support server-side processing for the following operators =, >= , <=, !=, LIKE, AND, and OR. Other filters are executed client side within the Cloud. For example, the following query is processed by LDAP:

SELECT * FROM Top WHERE  CN != 'NewUser' AND  BaseDN = 'CN=Users,DC=MyDC' LIMIT 5

Insert

To add a Top record, all fields can be specified except Id, DN, and BaseDN. Required fields that should be provided are RDN and ObjectClass. For example:

INSERT INTO Top (RDN, ObjectClass) VALUES ('CN=NewUser', 'top;person;organizationalPerson;user;inetOrgPerson')

Update

All columns except Id, DN, and BaseDN can be updated by providing the Id in the WHERE clause. For example:

UPDATE Top SET Description = 'test' WHERE Id = '1|CN=NewUser,CN=Users,DC=MyDC'

Delete

Top records can be deleted by providing the Id of the Top record in a DELETE statement. For example:

DELETE FROM Top WHERE Id = '1|CN=NewUser,CN=Users,DC=MyDC'

Columns


Name	Type	ReadOnly	References	DataFormat	Description
Id [KEY]	String	True			A combined index and Distinguished Name (DN). Multiple indices are supported if the column is set to 'SplitDataByRow'.
DN	String	True			The full Distinguished Name (DN) that represents the unique LDAP path of the object.
RDN	String	False			The Relative Distinguished Name (RDN), which is the unique part of the DN within its parent container.
BaseDN	String	True			The base Distinguished Name (BaseDN) that specifies the starting point for LDAP operations.
ObjectClass	String	False		DelimitedData	The hierarchical list of LDAP object classes from which this object is derived, defining its attributes and behavior.
SN	String	False		DelimitedData	Contains the user's surname or family name, such as 'Smith'.
CN	String	False		DelimitedData	Represents the common name of the object, often used for LDAP searches. For example, 'John Doe'.
GroupType	String	False		DelimitedData	Defines a set of flags indicating the type and scope of the group object. For example, it identifies whether it is a security or distribution group.
MemberOf	String	False		DelimitedData	Specifies the Distinguished Names (DNs) of the groups to which this object belongs. This establishes group membership relationships.
DC	String	False		DelimitedData	Specifies the Domain Component (DC) attribute for the Domain object class, used to identify the domain.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
Filter	String	Defines an explicit LDAP filter that overrides any other filter values set in the WHERE clause of the query.

User

Stores information about employees, contractors, or long-term visitors in an organization. Includes attributes such as name, contact details, and job-related information.

Table Specific Information

Select

All columns support server-side processing for the operators =, >= , <=, !=, LIKE, AND, and OR. Other filters are executed client side within the Cloud. For example, the following query is processed by LDAP:

SELECT * FROM User WHERE  Title LIKE '%abc%' AND  AdminCount != '1' LIMIT 5

Insert

To add a User, all fields can be specified except Id, DN, and BaseDN. Required fields that should be provided are RDN and ObjectClass. For example:

INSERT INTO [User] (RDN, ObjectClass) VALUES ('CN=TestUser', 'Top; Person; OrganizationalPerson; User')

Update

All columns except Id, DN, and BaseDN can be updated by providing the Id in the WHERE clause. For example:

UPDATE User SET PostalCode = '94042' WHERE Id = '1|CN=NewUser,CN=Users,DC=MyDC'

Delete

Users can be deleted by providing the Id of the User in a DELETE statement. For example:

DELETE FROM User WHERE Id = '1|CN=NewUser,CN=Users,DC=MyDC'

Columns


Name	Type	ReadOnly	References	DataFormat	Description
Id [KEY]	String	True			A combined index and Distinguished Name (DN). Multiple indices are supported when the column is set to 'SplitDataByRow'.
DN	String	True			The full Distinguished Name (DN) that uniquely identifies the object in the LDAP directory.
RDN	String	False			The Relative Distinguished Name (RDN), which is the unique portion of the DN within its parent container.
BaseDN	String	True			The base Distinguished Name (BaseDN) that specifies the starting point for LDAP operations.
ObjectClass	String	False		DelimitedData	A list of LDAP object classes that define the attributes and behavior of this object.
SN	String	False		DelimitedData	The surname or family name of the user, such as 'Smith'.
CN	String	False		DelimitedData	The common name of the object, used for identification and searches. For example, 'John Doe'.
UserPassword	String	False		DelimitedData	The user's password stored in UTF-8 format. This is a write-only attribute for security purposes.
TelephoneNumber	String	False		DelimitedData	The primary telephone number associated with the user or object.
SeeAlso	String	False		DelimitedData	A list of Distinguished Names (DNs) of objects that are related or linked to this one.
Description	String	False		DelimitedData	A textual description of the object. This attribute can be single-valued or multi-valued depending on compatibility requirements.
Title	String	False		DelimitedData	The user's formal job title, such as 'Senior Programmer', rather than occupational class, such as programmer. This does not include suffix titles like 'Esq.' or 'DDS'.
X121Address	String	False		DelimitedData	The X.121 address associated with the object, often used in telecommunications.
RegisteredAddress	String	False		DelimitedData	A mnemonic address associated with a specific city, registered in the relevant country or region.
DestinationIndicator	String	False		DelimitedData	An X.500 attribute that is not used in modern NTDS implementations.
PreferredDeliveryMethod	String	False		DelimitedData	The X.500-preferred method for delivering messages to the addressee.
TelexNumber	String	False		DelimitedData	A list of alternate telex numbers associated with the user or object.
TeletexTerminalIdentifier	String	False		DelimitedData	Specifies the Teletex terminal identifier and optional parameters for a teletex terminal linked to this object.
InternationalISDNNumber	String	False		DelimitedData	The International ISDN (Integrated Services Digital Network) number associated with the object.
FacsimileTelephoneNumber	String	False		DelimitedData	The telephone number of the user's business fax machine.
Street	String	False		DelimitedData	The street address of the user or object.
PostOfficeBox	String	False		DelimitedData	The post office box number associated with the user or object.
PostalCode	String	False		DelimitedData	The postal or ZIP code used for mail delivery to the user or object.
PostalAddress	String	False		DelimitedData	The complete mailing address of the user or object.
PhysicalDeliveryOfficeName	String	False		DelimitedData	The name or location of the user's office within their place of business.
OU	String	False		DelimitedData	The name of the Organizational Unit (OU) to which the user or object belongs.
ST	String	False		DelimitedData	The state or province associated with the user or object.
L	String	False		DelimitedData	The locality, such as a city or town, associated with the user or object.
UserCertificate	String	False		DelimitedData	A DER-encoded X.509v3 certificate issued to the user, including public key certificates provided by Microsoft Certificate Services.
NetworkAddress	String	False		DelimitedData	The TCP/IP address for a network segment, also referred to as the subnet address.
UserAccountControl	String	False		DelimitedData	Flags that define the behavior and access control of the user account.
BadPwdCount	String	False		DelimitedData	The number of failed login attempts for this account. A value of 0 indicates that the count is unknown.
CodePage	String	False		DelimitedData	Specifies the code page for the user's preferred language. This attribute is not used in modern Windows implementations.
HomeDirectory	String	False		DelimitedData	The home directory for the account. If 'homeDrive' specifies a drive letter, 'homeDirectory' must be a UNC path. Otherwise, it is a local path, including the drive letter (e.g., 'C:\Directory\Folder').
HomeDrive	String	False		DelimitedData	The drive letter to map to the UNC path specified in 'homeDirectory'. Must be in the format 'DriveLetter:', where 'DriveLetter' is an uppercase letter.
BadPasswordTime	Datetime	False		DelimitedData	The last date and time a failed login attempt was made using an incorrect password. Stored as a large integer representing the number of 100-nanosecond intervals since January 1, 1601 (UTC). A value of 0 indicates no record of failed attempts.
LastLogoff	String	False		DelimitedData	This attribute is not currently used in modern implementations.
LastLogon	Datetime	False		DelimitedData	The last time the user successfully logged on. Stored as a large integer representing the number of 100-nanosecond intervals since January 1, 1601 (UTC). A value of 0 indicates no record of login.
LastLogonTimestamp	Datetime	False		DelimitedData	The timestamp of the last time the user logged on. This value is stored as a large integer that represents the number of 100-nanosecond intervals since January 1, 1601 (UTC). A value of zero means that the last logon time is unknown.
DBCSPwd	String	False		DelimitedData	The LAN Manager password of the account. Used primarily for backward compatibility.
LocaleID	String	False		DelimitedData	A list of locale IDs representing the language and geographic preferences for the user.
ScriptPath	String	False		DelimitedData	The path to the user's login script. Can be null.
LogonHours	String	False		DelimitedData	Specifies the hours during which the user is allowed to log on to the domain.
LogonWorkstation	String	False		DelimitedData	Not used in modern implementations. Refer to the User-Workstations attribute instead.
MaxStorage	String	False		DelimitedData	Defines the maximum disk space the user can use. Use 'USER_MAXSTORAGE_UNLIMITED' to allow unlimited space.
UserWorkstations	String	False		DelimitedData	Lists the NetBIOS or DNS names of the computers from which the user can log on. Multiple names are separated by commas.
UnicodePwd	String	False		DelimitedData	The user's password stored in Windows NT one-way format (OWF). This is managed by the operating system, and the original password cannot be derived.
OtherLoginWorkstations	String	False		DelimitedData	Specifies non-Windows NT or LAN Manager workstations from which the user can log on.
NtPwdHistory	String	False		DelimitedData	The user's password history stored in Windows NT one-way format (OWF).
PwdLastSet	Datetime	False		DelimitedData	The date and time when the user's password was last changed. Stored as a large integer representing 100-nanosecond intervals since January 1, 1601 (UTC). A value of 0 indicates that the user must set a password at next login.
PreferredOU	String	False		DelimitedData	The Organizational Unit (OU) that is displayed by default on the user's desktop.
PrimaryGroupID	String	False		DelimitedData	The Relative Identifier (RID) for the user's primary group, typically the Domain Users group.
UserParameters	String	False		DelimitedData	A Unicode string reserved for application-specific user data. Can be null or contain any character string.
ProfilePath	String	False		DelimitedData	The path to the user's profile. This value can be a null string, a local absolute path, or a UNC path.
OperatorCount	String	False		DelimitedData	Tracks the number of operators assigned to the user.
AdminCount	String	False		DelimitedData	Indicates whether the system has adjusted the ACLs of the object for higher security due to membership in an administrative group.
AccountExpires	Datetime	False		DelimitedData	The date when the account expires. Stored as a large integer representing 100-nanosecond intervals since January 1, 1601 (UTC). A value of 0 or 0x7FFFFFFFFFFFFFFF indicates the account does not expire.
LmPwdHistory	String	False		DelimitedData	The password history of the user in LAN Manager (LM) format. Used for backward compatibility.
GroupMembershipSAM	String	False		DelimitedData	Provides support for down-level Windows NT group membership functionality.
LogonCount	String	False		DelimitedData	The number of successful logons for the account. A value of 0 indicates no record of successful logons.
ControlAccessRights	String	False		DelimitedData	Defines the specific rights required for users to perform operations on this object.
DefaultClassStore	String	False		DelimitedData	Specifies the default Class Store associated with the user.
GroupsToIgnore	String	False		DelimitedData	An attribute that is not currently used and has no functional effect.
GroupPriority	String	False		DelimitedData	An unused attribute associated with group priority.
DesktopProfile	String	False		DelimitedData	Specifies the desktop profile location for a user or group of users. This attribute is not currently used.
DynamicLDAPServer	String	False		DelimitedData	The DNS name of the server responsible for dynamic properties of this account.
UserPrincipalName	String	False		DelimitedData	An Internet-style login name for the user, based on RFC 822 standards. Typically maps to the user's email address for convenience. For more information about this attribute, see User Naming Attributes.
LockoutTime	Datetime	False		DelimitedData	The date and time (UTC) when the account was locked out. Stored as a large integer representing 100-nanosecond intervals since January 1, 1601 (UTC). A value of 0 indicates the account is not locked out.
UserSharedFolder	String	False		DelimitedData	Specifies a UNC path to the user's shared documents folder. The path must be a network UNC path of the form \\Server\Share\Directory. This value can be a null string.
UserSharedFolderOther	String	False		DelimitedData	Specifies an additional UNC path to the user's shared documents folder. The path must be a network UNC path of the form \\Server\Share\Directory. This value can be a null string.
ServicePrincipalName	String	False		DelimitedData	Lists the Service Principal Names (SPNs) used for mutual authentication with services on this computer.
ACSPolicyName	String	False		DelimitedData	Specifies the name of the ACS (Access Control System) policy that applies to the user.
TerminalServer	String	False		DelimitedData	Contains data used by the Windows NT Terminal Server. Not user-editable.
MSMQSignCertificates	String	False		DelimitedData	A collection of certificates issued to the user for Microsoft Message Queuing (MSMQ). Includes a digest for each certificate.
MSMQDigests	String	False		DelimitedData	An array of digests corresponding to the certificates in the MSMQSignCertificates attribute, used for certificate mapping.
MSMQDigestsMig	String	False		DelimitedData	In MSMQ mixed-mode, stores the previous value of the MSMQDigests attribute.
MSMQSignCertificatesMig	String	False		DelimitedData	In MSMQ mixed-mode, stores the previous value of the MSMQSignCertificates attribute.
MsNPAllowDialin	String	False		DelimitedData	Indicates whether the account is allowed to dial in to a RAS server. This value should be managed through RAS administration tools.
MsNPCallingStationID	String	False		DelimitedData	An attribute used internally for RAS. Do not modify directly.
MsNPSavedCallingStationID	String	False		DelimitedData	Stores the saved RAS calling station ID. This attribute is used internally and should not be modified directly.
MsRADIUSCallbackNumber	String	False		DelimitedData	The callback number used for RADIUS. This attribute is managed internally.
MsRADIUSFramedIPAddress	String	False		DelimitedData	Specifies the framed IP address for RADIUS. Managed internally.
MsRADIUSFramedRoute	String	False		DelimitedData	Defines the framed route for RADIUS. Managed internally.
MsRADIUSServiceType	String	False		DelimitedData	Indicates the RADIUS service type. Managed internally.
MsRASSavedCallbackNumber	String	False		DelimitedData	The saved RADIUS callback number. Managed internally.
MsRASSavedFramedIPAddress	String	False		DelimitedData	The saved RADIUS framed IP address. Managed internally.
MsRASSavedFramedRoute	String	False		DelimitedData	The saved RADIUS framed route. Managed internally.
MS-DS-CreatorSID	String	False		DelimitedData	The Security Identifier (SID) of the creator of the object containing this attribute.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
Filter	String	Defines an explicit LDAP filter that overrides any other filter specified in the WHERE clause.

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、LDAP の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにLDAP から関連するレスポンスデータを返します。

CData Cloud - LDAP ストアドプロシージャ


Name	Description
AddMembersToGroup	Adds specified users to a group in the LDAP directory. The group and user entries are identified by their Distinguished Names (DNs).
ChangePassword	Changes the password of the current user. Requires the current password for authentication. Use ResetPassword for administrator-level password resets. The User in the connection settings must be a valid DN, and the connection must use SSL for security.
GetAttributes	Retrieves all attribute names and their corresponding values for a specified Distinguished Name (DN) in the LDAP directory.
MoveToDN	Moves an object from one Distinguished Name (DN) location to another in the LDAP directory.
RemoveMembersFromGroup	Removes specified users from a group in the LDAP directory. The group and users are identified by their Distinguished Names (DNs).
ResetPassword	Resets the password for a specific user identified by DN. Use this procedure for administrator-level resets when the current password is not required. The AdminUser or User in the connection settings must be a valid DN, and the connection must use SSL.

AddMembersToGroup

Adds specified users to a group in the LDAP directory. The group and user entries are identified by their Distinguished Names (DNs).

Stored Procedure Specific Information

AddMembersToGroup

Adding members to groups with LDAP requires updating the Member field of the Group object with all the UserDNs to be added to the group. The UserDNs input must be provided as a JSON file.

You can provide the UserDNs in either of the following ways:

To add the UserDNs via a temporary table:

INSERT INTO UserDNs#TEMP ([DN]) 
SELECT DN FROM [User] WHERE Id LIKE '%Test%'
EXEC AddMembersToGroup @GroupId = '1|CN=jhbkrb5,OU=Kerberos,OU=TIBCODV,DC=NS3,DC=local', @UserDNs = 'UserDNs#TEMP'

To provide the JSON body of the object-array directly:

EXEC AddMembersToGroup @GroupId = '1|CN=jhbkrb5,OU=Kerberos,OU=TIBCODV,DC=NS3,DC=local', 
				 @UserDNs = '[{"DN": "CN=Test3333,DC=NS3,DC=local;CN=Test33,DC=NS3,DC=local"}]'

Input


Name	Type	Description
GroupId	String	Specifies the unique identifier (ID) of the group to which users will be added. This ID should correspond to an existing group record in the LDAP directory.
UserDNs	String	An aggregate or temporary table containing the Distinguished Names (DNs) of users to be added to the specified group. Each DN must correspond to an existing user record in the LDAP directory.

Result Set Columns


Name	Type	Description
Success	String	Returns a boolean status indicating whether the users were successfully added to the specified group.

ChangePassword

Changes the password of the current user. Requires the current password for authentication. Use ResetPassword for administrator-level password resets. The User in the connection settings must be a valid DN, and the connection must use SSL for security.

Input


Name	Type	Description
NewPassword	String	Specifies the new password to be set for the user identified by their Distinguished Name (DN). Ensure the new password complies with the LDAP server's password policies.
PasswordAttribute	String	Defines the specific password attribute used by your LDAP server for password updates. For example, Active Directory typically uses 'unicodePwd', while other LDAP servers may require 'userPassword'. デフォルト値はunicodePwdです。

Result Set Columns


Name	Type	Description
Success	String	Indicates whether the password update operation was successfully completed on the LDAP server.

GetAttributes

Retrieves all attribute names and their corresponding values for a specified Distinguished Name (DN) in the LDAP directory.

Input


Name	Type	Description
DN	String	Specifies the Distinguished Name (DN) of the LDAP object for which attributes are being retrieved. If left unspecified, the BaseDN from the connection string will be used as the default.

Result Set Columns


Name	Type	Description
AttributeName	String	Provides the names of the attributes associated with the specified DN. This output lists all available attribute names for the object.
AttributeValue	String	Returns the corresponding values for the attributes of the specified DN. Each value corresponds to the attribute name in the output.

MoveToDN

Moves an object from one Distinguished Name (DN) location to another in the LDAP directory.

Input


Name	Type	Description
DN	String	Specifies the current Distinguished Name (DN) of the object to be moved on the LDAP server. For example, 'cn=Bob F,ou=Employees,dc=Domain'. This DN identifies the object's current location in the directory.
NewParentDN	String	Defines the new parent Distinguished Name (DN) where the object should be moved. For example, 'ou=Test Org,dc=Domain'. This DN specifies the new location in the LDAP directory.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether the object was successfully moved to the new location in the LDAP directory.

RemoveMembersFromGroup

Removes specified users from a group in the LDAP directory. The group and users are identified by their Distinguished Names (DNs).

Stored Procedure Specific Information

RemoveMembersFromGroup

Removing members from groups with LDAP requires updating the Member field of the Group object with all the UserDNs to be removed from the group. The UserDNs input must be provided as a JSON file.

You can provide the UserDNs in either of the following ways:

To add the UserDNs via a temporary table:

REMOVE FROM UserDNs#TEMP ([DN]) 
SELECT DN FROM [User] WHERE Id LIKE '%Test%'
EXEC RemoveMembersFromGroup @GroupId = '1|CN=jhbkrb5,OU=Kerberos,OU=TIBCODV,DC=NS3,DC=local', @UserDNs = 'UserDNs#TEMP'

To provide the JSON body of the object-array directly:

EXEC RemoveMembersFromGroup @GroupId = '1|CN=jhbkrb5,OU=Kerberos,OU=TIBCODV,DC=NS3,DC=local', 
				 @UserDNs = '[{"DN": "CN=Test3333,DC=NS3,DC=local;CN=Test33,DC=NS3,DC=local"}]'

Input


Name	Type	Description
GroupId	String	Specifies the unique identifier (ID) of the group from which users will be removed. This ID should correspond to an existing group record in the LDAP directory.
UserDNs	String	Defines an aggregate or temporary table containing the Distinguished Names (DNs) of users to be removed from the specified group. Each DN should represent an existing user record in the LDAP directory.

Result Set Columns


Name	Type	Description
Success	String	Indicates whether the operation to remove members from the group was successfully completed.

ResetPassword

Resets the password for a specific user identified by DN. Use this procedure for administrator-level resets when the current password is not required. The AdminUser or User in the connection settings must be a valid DN, and the connection must use SSL.

Input


Name	Type	Description
AdminUser	String	Specifies the Distinguished Name (DN) or username of an administrator account used to bind to the server for authentication. For example, 'Domain\BobF' or 'cn=Bob F,ou=Employees,dc=Domain'.
AdminPassword	String	The password for the administrator account used to authenticate and bind to the LDAP server.
User	String	Specifies the Distinguished Name (DN) or username of the user account for which the password is being reset. For example, 'Domain\BobF' or 'cn=Bob F,ou=Employees,dc=Domain'.
NewPassword	String	Specifies the new password to be assigned to the user account identified by the DN. Ensure that the new password complies with the LDAP server's password policies.
PasswordAttribute	String	Defines the specific password attribute used by your LDAP server for updating passwords. For example, Active Directory typically uses 'unicodePwd', while other LDAP servers may require 'userPassword'. デフォルト値はunicodePwdです。

Result Set Columns


Name	Type	Description
Success	String	Indicates whether the password reset operation was successfully completed on the LDAP server.

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、LDAP のデータベースメタデータを返します。

sys_catalogs：利用可能なデータベースをリスト。
sys_schemas：利用可能なスキーマをリスト。
sys_tables：利用可能なテーブルおよびビューをリスト。
sys_tablecolumns：利用可能なテーブルおよびビューのカラムについて説明。
sys_procedures：利用可能なストアドプロシージャについて説明。
sys_procedureparameters：ストアドプロシージャパラメータについて説明。
sys_keycolumns：主キーおよび外部キーについて説明。
sys_indexes：利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

sys_connection_props：利用可能な接続プロパティについての情報を返す。
sys_sqlinfo：Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリのクエリ統計を返します。

sys_identity：バッチ処理または単一の更新に関する情報を返す。

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	データベース名。

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	データベース名。
SchemaName	String	スキーマ名。

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベース。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	テーブル名またはビュー名。
TableType	String	テーブルの種類（テーブルまたはビュー）。
Description	String	テーブルまたはビューの説明。
IsUpdateable	Boolean	テーブルが更新可能かどうか。

sys_tablecolumns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、User テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='User'

Columns


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 から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType	String	スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベース。
SchemaName	String	ストアドプロシージャを含むスキーマ。
ProcedureName	String	ストアドプロシージャの名前。
Description	String	ストアドプロシージャの説明。
ProcedureType	String	PROCEDURE やFUNCTION などのプロシージャのタイプ。

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、ChangePassword ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'ChangePassword' AND Direction = 1 OR Direction = 2

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'ChangePassword' AND IncludeResultColumns='True'

Columns


Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベースの名前。
SchemaName	String	ストアドプロシージャを含むスキーマの名前。
ProcedureName	String	パラメータを含むストアドプロシージャの名前。
ColumnName	String	ストアドプロシージャパラメータの名前。
Direction	Int32	パラメータのタイプに対応する整数値：input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName	String	データ型の名前。
NumericPrecision	Int32	数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ（文字数）。
Length	Int32	文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale	Int32	数値データの小数点以下の桁数。
IsNullable	Boolean	パラメータがNull を含められるかどうか。
IsRequired	Boolean	プロシージャの実行にパラメータが必要かどうか。
IsArray	Boolean	パラメータが配列かどうか。
Description	String	パラメータの説明。
Ordinal	Int32	パラメータのインデックス。
Values	String	このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams	Boolean	パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath	Boolean	パラメータがスキーマ作成操作のターゲットパスかどうか。
Default	String	何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName	String	複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided	Boolean	プロシージャがネイティブのLDAP プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns


Name	Type	Description
IncludeResultColumns	Boolean	出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、User テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='User'

Columns


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	主キーのカラム名。

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         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	外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前。
KeySeq	String	主キーのシーケンス番号。
KeyName	String	主キーの名前。

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


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	インデックスのカラムのシーケンスナンバー。

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


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	プロパティに関するその他のさまざまな情報。

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠を参照してください。

データソースのSELECT 機能

以下は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 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、サンプルデータモデルセクションを参照してください。

Columns


Name	Type	Description
NAME	String	SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE	String	サポートされるSQL またはSQL 構文の詳細。

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	データ変更処理から返された、データベース生成Id。
Batch	String	バッチの識別子。1 は単一処理。
Operation	String	バッチ内の処理の結果：INSERTED、UPDATED、またはDELETED。
Message	String	SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns


Name	Type	Description
Product	String	製品名。
Version	String	製品のバージョン番号。
Datasource	String	製品が接続するデータソースの名前。
NodeId	String	製品がインストールされているマシンの固有識別子。
HelpURL	String	製品のヘルプドキュメントのURL。
License	String	製品のライセンス情報。（この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。）
Location	String	製品のライブラリが格納されているファイルパスの場所。
Environment	String	製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersion	String	本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategory	String	CData Sync 機能のカテゴリ（例：Source、Destination）。

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication

プロパティ	説明
Schema	Specify the version to connect with. Allows users to choose using the table and column information provided by Active Directory over the hard-coded column values in the .rsd files
Server	LDAP サーバーのドメイン名またはIP アドレスを指定します。このプロパティは接続を確立するために必要であり、LDAP:\\\\ 接頭辞を含める必要はありません。サーバーのドメイン名、およびIP アドレスだけで十分です。
Port	LDAP サーバーが起動しているポート番号を指定します。
User	LDAP サーバーとの認証に使用されるユーザーアカウントの識別名（DN）を指定します。このプロパティは、サーバーが認証を強制する場合に必要です。
Password	LDAP サーバーとの認証に使用されるユーザーアカウントの識別名（DN）に関連付けられたパスワードを指定します。このプロパティは、サーバーが認証を強制する場合に必要です。
BaseDN	LDAP クエリをディレクトリ内の特定のサブツリーに限定するために、識別名（DN）のベース部分を指定します。ベースDN を使用すると、検索範囲が狭まり、特に大きなLDAP サーバーではクエリのパフォーマンスが向上します。
UseSSL	Specifies whether SSL is used to secure the connection to the LDAP server. Enabling this property ensures that communication between the client and server is encrypted.
LDAPVersion	サーバーへの接続時に使用するLDAP プロトコルのバージョンを指定します。サポートされている値は2および3です。
AuthMechanism	LDAP サーバーへの接続時に使用する認証メカニズムを指定します。サポートされる値は、プレーンテキスト認証の場合はSIMPLE、NTLM/Negotiate 認証の場合はNEGOTIATE です。
Scope	LDAP 検索のスコープを指定します。このプロパティは、検索がサブツリー全体（BaseDN およびすべての下の階層）、単一のレベル（BaseDN および、直接の子階層）、もしくはベースオブジェクトのみ（BaseDN のみ）のいずれに適用されるかを定義します。
DNAttributeFilter	Specifies whether to use distinguishedName or entryDN as the DN attribute in LDAP query filters. This property affects how the distinguished name is referenced during search operations.

SSL

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging

プロパティ	説明
Verbosity	ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema

プロパティ	説明
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous

プロパティ	説明
FollowReferrals	LDAP サーバーにより返されるLDAP リファーラルに従うかどうかを指定します。有効にすると、プロバイダーは元のサーバーではなく、リファーラルサーバーからデータを取得します。
FriendlyGUID	Specifies whether GUID attributes, such as objectGUID, are returned in a human-readable string format or as base64-encoded binary objects. When enabled, the property converts GUIDs into a friendly string format.
FriendlySID	Specifies whether SID attributes, such as objectSid, are returned in a human-readable string format or as base64-encoded binary objects. When enabled, the property converts SIDs into a friendly string format.
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ThrowsKeyNotFound	更新された行がない場合に例外をスローするかどうかを指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

プロパティ	説明
Schema	Specify the version to connect with. Allows users to choose using the table and column information provided by Active Directory over the hard-coded column values in the .rsd files
Server	LDAP サーバーのドメイン名またはIP アドレスを指定します。このプロパティは接続を確立するために必要であり、LDAP:\\\\ 接頭辞を含める必要はありません。サーバーのドメイン名、およびIP アドレスだけで十分です。
Port	LDAP サーバーが起動しているポート番号を指定します。
User	LDAP サーバーとの認証に使用されるユーザーアカウントの識別名（DN）を指定します。このプロパティは、サーバーが認証を強制する場合に必要です。
Password	LDAP サーバーとの認証に使用されるユーザーアカウントの識別名（DN）に関連付けられたパスワードを指定します。このプロパティは、サーバーが認証を強制する場合に必要です。
BaseDN	LDAP クエリをディレクトリ内の特定のサブツリーに限定するために、識別名（DN）のベース部分を指定します。ベースDN を使用すると、検索範囲が狭まり、特に大きなLDAP サーバーではクエリのパフォーマンスが向上します。
UseSSL	Specifies whether SSL is used to secure the connection to the LDAP server. Enabling this property ensures that communication between the client and server is encrypted.
LDAPVersion	サーバーへの接続時に使用するLDAP プロトコルのバージョンを指定します。サポートされている値は2および3です。
AuthMechanism	LDAP サーバーへの接続時に使用する認証メカニズムを指定します。サポートされる値は、プレーンテキスト認証の場合はSIMPLE、NTLM/Negotiate 認証の場合はNEGOTIATE です。
Scope	LDAP 検索のスコープを指定します。このプロパティは、検索がサブツリー全体（BaseDN およびすべての下の階層）、単一のレベル（BaseDN および、直接の子階層）、もしくはベースオブジェクトのみ（BaseDN のみ）のいずれに適用されるかを定義します。
DNAttributeFilter	Specifies whether to use distinguishedName or entryDN as the DN attribute in LDAP query filters. This property affects how the distinguished name is referenced during search operations.

解説

This property specifies whether the connection to the LDAP server should be encrypted using SSL. If set to true, SSL is used to secure the connection. By default, this property is set to false, meaning SSL is not enforced.

However, note the following about LDAP standard ports:

Port 636: This port is always encrypted as it is the standard LDAP SSL port. SSL is automatically applied when this port is used, even if this property is set to false.
Port 389: This port is typically used for unencrypted connections.

string

デフォルト値

"WHOLESUBTREE"

解説

このプロパティは、パフォーマンスとクエリ結果のバランスをとるのに役立ちます。ディレクトリ階層全体のエントリを取得する必要がある幅広い検索には、WHOLESUBTREE を使用します。より焦点を絞ったクエリには、SINGLELEVEL を選択して結果をBaseDN の直接の子階層に限定するか、BASEOBJECT を選択してBaseDN 自体だけを取得します。検索スコープを狭めることで、不必要なオーバーヘッドを減らし、特に大きなディレクトリでのクエリ効率を向上させることができます。

WHOLESUBTREE（デフォルト）： BaseDN およびすべての子階層を検索します。
SINGLELEVEL： BaseDN および1つ下の子階層のみを検索します。
BASEOBJECT： 子階層含めずに、BaseDN 自身だけを検索します。

DNAttributeFilter

Specifies whether to use distinguishedName or entryDN as the DN attribute in LDAP query filters. This property affects how the distinguished name is referenced during search operations.

Possible Values

distinguishedName, entryDN

データ型

string

デフォルト値

"distinguishedName"

解説

This property is useful for specifying how the DN is handled in filters for LDAP queries. The default value is distinguishedName, which is widely used in most LDAP servers. For servers or configurations that rely on entryDN for DN filtering, update this property accordingly. Ensure that the chosen attribute is supported by your LDAP server to avoid query errors.

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

SSLServerCert

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`

Note：'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

プロパティ	説明
Verbosity	ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。より高いVerbosity レベルは主にデバッグを目的としています。各レベルの詳細については、ログを参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

プロパティ	説明
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

プロパティ	説明
FollowReferrals	LDAP サーバーにより返されるLDAP リファーラルに従うかどうかを指定します。有効にすると、プロバイダーは元のサーバーではなく、リファーラルサーバーからデータを取得します。
FriendlyGUID	Specifies whether GUID attributes, such as objectGUID, are returned in a human-readable string format or as base64-encoded binary objects. When enabled, the property converts GUIDs into a friendly string format.
FriendlySID	Specifies whether SID attributes, such as objectSid, are returned in a human-readable string format or as base64-encoded binary objects. When enabled, the property converts SIDs into a friendly string format.
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
ThrowsKeyNotFound	更新された行がない場合に例外をスローするかどうかを指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください：

*=*

ThrowsKeyNotFound

更新された行がない場合に例外をスローするかどうかを指定します。

データ型

bool

デフォルト値

false

解説

更新された行がない場合に例外をスローするかどうかを指定します。

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note： このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Cloud

LDAP - CData Cloud

概要

主要機能

はじめに

LDAP への接続

CData Cloud サービスからデータにアクセス

接続の確立

LDAP への接続

必須プロパティ

オプションのプロパティ

LDAP への認証

SSL Configuration

テーブルのカスタマイズ

LDAP テーブルとの連携

新しいテーブルを定義する

テーブルカラムおよびインプット

テーブル設定

オペレーション定義

SSL の設定

SSL 設定のカスタマイズ

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

サンプルデータモデル

テーブル

ストアドプロシージャ

テーブル

CData Cloud - LDAP テーブル

Group

テーブル固有の情報

Select

Insert

Update

Delete

Columns

Pseudo-Columns

OrganizationalPerson

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

Person

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

Top

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

User

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

ストアドプロシージャ

CData Cloud - LDAP ストアドプロシージャ

AddMembersToGroup

Stored Procedure Specific Information

AddMembersToGroup

Input

Result Set Columns

ChangePassword

Input

Result Set Columns

GetAttributes

Input