CData Cloud offers access to LDAP across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to LDAP through CData Cloud.
CData Cloud allows you to standardize and configure connections to LDAP as though it were any other OData endpoint or standard SQL Server.
This page provides a guide to Establishing a Connection to LDAP in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to LDAP and configure any necessary connection properties to create a database in CData Cloud
Accessing data from LDAP through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to LDAP by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
The CData driver for the LDAP supports connecting to LDAP server objects. To connect, set the required properties.
Optional properties can be used to further refine control of the returned results.
To authenticate requests, set the User and Password properties to valid LDAP credentials. For example: set User to Domain\\BobF or cn=Bob F,ou=Employees,dc=Domain.
The AuthMechanism properties for the Cloud are as follows:
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.
The Cloud surfaces the columns most often needed from LDAP entities. However, if you need to work with other data, the tables are easy to modify. Tables are defined in schema files, which have a simple format.
See Working with LDAP Tables for a guide to extending the default schemas or writing your own. To use custom schemas, set the Location property to the folder containing the schema files. For more on tables and views, see Data Model.
The Cloud includes table schemas for many standard LDAP objects. You can easily extend the included table schemas to edit column behavior or you can write your own from scratch.
Table schemas are defined in .rsd files, which are simple configuration files. This section will walk through different parts of the schema, adding several columns to the Person table as an example.
You can find the Person.rsd file in the db subfolder in the installation folder of the CData Cloud.
To use custom schemas, set the Location property to the folder containing the schema files.
It is important to define a new table with the same name as the object class that the table will represent. This will allow the Cloud to search for only the desired object class when querying the LDAP server. The file name defines the table name.
There are a few columns that every table should include, regardless of the object class:
<rsb:script xmlns:rsb="http://www.rssbus.com/ns/rsbscript/2">
<rsb:info title="Person" description="Create, update, delete, and query person entries in Active Directory.">
<!-- Required Columns -->
<attr name="Id" xs:type="string" readonly="true" key="true" />
<attr name="DN" xs:type="string" readonly="true" required="false" other:ldaptype="OID" />
<attr name="RDN" xs:type="string" readonly="true" required="false" other:ldaptype="Directory String" />
<attr name="BaseDN" xs:type="string" readonly="true" required="false" other:ldaptype="OID" />
Note: The title attribute of the rsb:info block must match the name of the .rsd file.
Each column requires at least name and xs:type attributes. Additionally, you will need to specify dataFormat to decide how data is returned from the table. For example:
<!-- Person Required Attributes -->
<attr name="ObjectClass" other:dataFormat="splitDataByRow" xs:type="string" readonly="false" required="false" other:ldaptype="OID" />
<attr name="SN" other:dataFormat="delimitedData" xs:type="string" readonly="false" required="false" other:ldaptype="Directory String" />
<attr name="CN" other:dataFormat="delimitedData" xs:type="string" readonly="false" required="false" other:ldaptype="Directory String" />
<!-- Person Optional Attributes -->
<attr name="UserPassword" other:dataFormat="delimitedData" xs:type="string" readonly="false" required="false" other:ldaptype="Binary" />
<attr name="TelephoneNumber" other:dataFormat="delimitedData" xs:type="string" readonly="false" required="false" other:ldaptype="Directory String" />
<attr name="SeeAlso" other:dataFormat="delimitedData" xs:type="string" readonly="false" required="false" other:ldaptype="DN" />
<attr name="Description_1" other:dataFormat="splitDataByCol" xs:type="string" readonly="false" required="false" other:ldaptype="Directory String" />
<attr name="Description_2" other:dataFormat="splitDataByCol" xs:type="string" readonly="false" required="false" other:ldaptype="Directory String" />
<attr name="Description_3" other:dataFormat="splitDataByCol" xs:type="string" readonly="false" required="false" other:ldaptype="Directory String" />
The other:dataFormat attribute has three options:
delimitedData: Return multiple LDAP attribute values as delimited strings, separated by the delimiter character defined in the Table Settings section of the .rsd file, detailed later.
This is the default format in which to retrieve data and the delimiter defaults to a semicolon.
The code below can be used to split the different values of the ObjectClass attributes into their own rows and Description attributes into their own columns. Notice the column definition now includes multiple columns for the Description attribute. Also note the other:dataFormat attribute for the attr.
...
<attr name="ObjectClass" other:dataFormat="delimitedData" xs:type="string" readonly="false" required="false" other:ldaptype="OID" />
<attr name="SN" other:dataFormat="delimitedData" xs:type="string" readonly="false" required="false" other:ldaptype="Directory String" />
<attr name="CN" other:dataFormat="delimitedData" xs:type="string" readonly="false" required="false" other:ldaptype="Directory String" />
<attr name="UserPassword" other:dataFormat="delimitedData" xs:type="string" readonly="false" required="false" other:ldaptype="Binary" />
<attr name="TelephoneNumber" other:dataFormat="delimitedData" xs:type="string" readonly="false" required="false" other:ldaptype="Directory String" />
<attr name="SeeAlso" other:dataFormat="delimitedData" xs:type="string" readonly="false" required="false" other:ldaptype="DN" />
<attr name="Description_1" other:dataFormat="delimitedData" xs:type="string" readonly="false" required="false" other:ldaptype="Directory String" />
<attr name="Description_2" other:dataFormat="delimitedData" xs:type="string" readonly="false" required="false" other:ldaptype="Directory String" />
<attr name="Description_3" other:dataFormat="delimitedData" xs:type="string" readonly="false" required="false" other:ldaptype="Directory String" />
</rsb:info>
<!-- Table Settings -->
<rsb:set attr="delimiter" value=";"/>
...
An example result will look like:
| 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 |
In addition to data format on inputs, encoding can also be specified. Currently, returning data with UTF8 encoding or BASE64 encoding is supported. In order to retrieve data with a specified encoding, the other:encoding field must be specified for the desired attribute to be encoded. If no encoding is specified, UTF8 is the default.
An example of specifying encoding for an attribute:
...
<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."/>
...
Optionally, there are two attributes that can be used to control how filtering is handled. The other:ldaptype attribute can be used to set the LDAP syntax of a field. This is used to determine the comparison operators that are supported server-side on a per-field basis. For example, if a field is marked as the type 'DN' and a query filtering for a substring (i.e., CONTAINS), which is not supported server-side, the driver will instead process this part of the filter entirely client-side. The supported type names are found in section 4.3.2 of RFC 2252. If you are unsure of the type or just want to disable server-side filtering for a given column entirely, the other:filterable attribute is also available. Setting this to false for the field will prevent this from ever being sent to the server in a filter, overriding the other:ldaptype attribute entirely.
In addition to the attributes and inputs, you will need to specify the delimiter.
The delimiter specifies the character that will be used for delimited data. Delimited data will be returned for any attribute that appears multiple times for a single object (unless otherwise specified in other:dataFormat).
For example, the code below will concatenate multiple values of an attribute using the ';' character.
...
</rsb:info>
<!-- Table Settings -->
<rsb:set attr="delimiter" value=";"/>
...
Operation definitions will remain exactly the same for all newly created tables: Simply copy and paste these from an existing table, as needed.
<!-- 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>
To enable TLS, set the following:
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.
To specify another certificate, see the SSLServerCert connection property.
Set the following properties:
The CData Cloud models LDAP data as an easy-to-use SQL database. It also includes Stored Procedures that extend the functionality of the Cloud.
The included Tables cover many standard object classes, which define the structure and rules for LDAP directory entries. You can easily extend the table schemas to map more closely to your LDAP classes by modifying simple configuration files. See Working with LDAP Tables for a guide to customizing table schemas.
Note: To use custom tables and schemas, set the Location property to the folder containing the schema files.
The following tables are shipped with the Cloud.
| Table | 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. |
The Cloud models the data in LDAP as a list of tables in a relational database that can be queried using standard SQL statements.
| 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. |
Stores a list of user Distinguished Names (DNs) for managing access and security roles on organizational resources.
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 Group WHERE GroupType != '-2147483644' AND ObjectClass = 'top;group' LIMIT 5
To add a Group, all fields can be specified except Id, DN, and BaseDN. Required fields that should be provided are RDN and ObjectClass. For example:
INSERT INTO Group (RDN, ObjectClass) VALUES ('CN=Domain Admins', 'group')
All columns except Id, DN, and BaseDN can be updated by providing the Id in the WHERE clause. For example:
UPDATE Group SET Member = 'CN=SUPPORT_388945a0,CN=Users,DC=MyDC' WHERE Id = '1|CN=HelpServicesGroup,CN=Users,DC=MyDC'
Groups can be deleted by providing the Id of the Group in a DELETE statement. For example:
DELETE FROM Group WHERE Id = '1|CN=HelpServicesGroup,CN=Users,DC=MyDC'
| 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. | |
| String | False | DelimitedData |
A list of email addresses associated with the group or its members. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Filter | String |
Defines an explicit LDAP filter that overrides other filter values set in the WHERE clause of the query. |
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.
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
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')
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'
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'
| 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 column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Filter | String |
Defines an explicit LDAP filter, overriding other filters defined in the WHERE clause of the query. |
Stores personal information about a user, including general details such as name and contact information.
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
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')
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'
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'
| 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 column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Filter | String |
Defines an explicit LDAP filter, overriding other filters defined in the WHERE clause of the query. |
The root class from which all other LDAP classes are derived. It provides foundational attributes for other directory classes.
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
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')
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'
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'
| 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 column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Filter | String |
Defines an explicit LDAP filter that overrides any other filter values set in the WHERE clause of the query. |
Stores information about employees, contractors, or long-term visitors in an organization. Includes attributes such as name, contact details, and job-related information.
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
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')
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'
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'
| 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 column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description |
| Filter | String |
Defines an explicit LDAP filter that overrides any other filter specified in the WHERE clause. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with LDAP.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from LDAP, along with an indication of whether the procedure succeeded or failed.
| 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. |
Adds specified users to a group in the LDAP directory. The group and user entries are identified by their Distinguished Names (DNs).
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"}]'
| 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. |
| Name | Type | Description |
| Success | String | Returns a boolean status indicating whether the users were successfully added to the specified group. |
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.
| 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'.
The default value is unicodePwd. |
| Name | Type | Description |
| Success | String | Indicates whether the password update operation was successfully completed on the LDAP server. |
Retrieves all attribute names and their corresponding values for a specified Distinguished Name (DN) in the LDAP directory.
| 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. |
| 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. |
Moves an object from one Distinguished Name (DN) location to another in the LDAP directory.
| 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. |
| Name | Type | Description |
| Success | String | Indicates whether the object was successfully moved to the new location in the LDAP directory. |
Removes specified users from a group in the LDAP directory. The group and users are identified by their Distinguished Names (DNs).
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"}]'
| 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. |
| Name | Type | Description |
| Success | String | Indicates whether the operation to remove members from the group was successfully completed. |
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.
| 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'.
The default value is unicodePwd. |
| Name | Type | Description |
| Success | String | Indicates whether the password reset operation was successfully completed on the LDAP server. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for LDAP:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | The database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view. |
| TableType | String | The table type (table or view). |
| Description | String | A description of the table or view. |
| IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the User table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='User'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view containing the column. |
| ColumnName | String | The column name. |
| DataTypeName | String | The data type name. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The storage size of the column. |
| DisplaySize | Int32 | The designated column's normal maximum width in characters. |
| NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
| IsNullable | Boolean | Whether the column can contain null. |
| Description | String | A brief description of the column. |
| Ordinal | Int32 | The sequence number of the column. |
| IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
| IsGeneratedColumn | String | Whether the column is generated. |
| IsHidden | Boolean | Whether the column is hidden. |
| IsArray | Boolean | Whether the column is an array. |
| IsReadOnly | Boolean | Whether the column is read-only. |
| IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
| ColumnType | String | The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | The database containing the stored procedure. |
| SchemaName | String | The schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure. |
| Description | String | A description of the stored procedure. |
| ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the ChangePassword stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'ChangePassword' AND Direction = 1 OR Direction = 2
To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'ChangePassword' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the stored procedure. |
| SchemaName | String | The name of the schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure containing the parameter. |
| ColumnName | String | The name of the stored procedure parameter. |
| Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| DataTypeName | String | The name of the data type. |
| NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
| Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
| NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
| IsNullable | Boolean | Whether the parameter can contain null. |
| IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
| IsArray | Boolean | Whether the parameter is an array. |
| Description | String | The description of the parameter. |
| Ordinal | Int32 | The index of the parameter. |
| Values | String | The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated. |
| SupportsStreams | Boolean | Whether the parameter represents a file that you can pass as either a file path or a stream. |
| IsPath | Boolean | Whether the parameter is a target path for a schema creation operation. |
| Default | String | The value used for this parameter when no value is specified. |
| SpecificName | String | A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here. |
| IsCDataProvided | Boolean | Whether the procedure is added/implemented by CData, as opposed to being a native LDAP procedure. |
| Name | Type | Description |
| IncludeResultColumns | Boolean | Whether the output should include columns from the result set in addition to parameters. Defaults to False. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the User table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='User'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
| IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
| ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| KeySeq | String | The sequence number of the primary key. |
| KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the index. |
| SchemaName | String | The name of the schema containing the index. |
| TableName | String | The name of the table containing the index. |
| IndexName | String | The index name. |
| ColumnName | String | The name of the column associated with the index. |
| IsUnique | Boolean | True if the index is unique. False otherwise. |
| IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
| Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
| SortOrder | String | The sort order: A for ascending or D for descending. |
| OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | The name of the connection property. |
| ShortDescription | String | A brief description. |
| Type | String | The data type of the connection property. |
| Default | String | The default value if one is not explicitly set. |
| Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
| Value | String | The value you set or a preconfigured default. |
| Required | Boolean | Whether the property is required to connect. |
| Category | String | The category of the connection property. |
| IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
| Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
| PropertyName | String | A camel-cased truncated form of the connection property name. |
| Ordinal | Int32 | The index of the parameter. |
| CatOrdinal | Int32 | The index of the parameter category. |
| Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
| Visible | Boolean | Informs whether the property is visible in the connection UI. |
| ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
| Name | Description | Possible Values |
| AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | Whether COUNT function is supported. | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
| SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | Supported 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 | Supported 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 | Supported date/time 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 | Indicates tables skipped during replication. | |
| REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
| IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
| SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
| DIALECT | Indicates the SQL dialect to use. | |
| KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
| SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
| DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
| SQL_CAP | All supported SQL capabilities for this driver. | 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 | A string value specifies the preferred cacheOptions. | |
| ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
| PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
| MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
| REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
| REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
| REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
| REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
| CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
| Name | Type | Description |
| NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
| VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | The database-generated Id returned from a data modification operation. |
| Batch | String | An identifier for the batch. 1 for a single operation. |
| Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
| Message | String | SUCCESS or an error message if the update in the batch failed. |
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | The name of the product. |
| Version | String | The version number of the product. |
| Datasource | String | The name of the datasource the product connects to. |
| NodeId | String | The unique identifier of the machine where the product is installed. |
| HelpURL | String | The URL to the product's help documentation. |
| License | String | The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
| Location | String | The file path location where the product's library is stored. |
| Environment | String | The version of the environment or rumtine the product is currently running under. |
| DataSyncVersion | String | The tier of CData Sync required to use this connector. |
| DataSyncCategory | String | The category of CData Sync functionality (e.g., Source, Destination). |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| 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 | Specifies the domain name or IP address of the LDAP server. This property is required to establish a connection and does not need to include the LDAP:\\\\ prefix, only the server’s domain name or IP address. |
| Port | Specifies the port number on which the LDAP server is running. |
| User | Specifies the distinguished name (DN) of the user account to be used for authentication with the LDAP server. This property is required when the server enforces authentication. |
| Password | Specifies the password associated with the distinguished name (DN) of the user account used for authentication with the LDAP server. This property is required when the server enforces authentication. |
| BaseDN | Specifies the base portion of the distinguished name (DN) to limit LDAP queries to a specific subtree within the directory. Using a base DN helps narrow the search scope and improve query performance, especially on large LDAP servers. |
| 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 | Specifies the version of the LDAP protocol to use when connecting to the server. The supported values are 2 and 3. |
| AuthMechanism | Specifies the authentication mechanism to use when connecting to the LDAP server. Supported values are SIMPLE for plaintext authentication and NEGOTIATE for NTLM/Negotiate authentication. |
| Scope | Specifies the scope of the LDAP search. This property defines whether the search applies to the entire subtree (BaseDN and all its descendants), a single level (BaseDN and its direct descendants), or just the base object (BaseDN only). |
| 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. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Property | Description |
| FollowReferrals | Specifies whether to follow LDAP referrals returned by the LDAP server. When enabled, the provider retrieves data from the referred servers instead of the original server. |
| 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 | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| ThrowsKeyNotFound | Specifies whether or not throws an exception if there is no rows updated. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| 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 | Specifies the domain name or IP address of the LDAP server. This property is required to establish a connection and does not need to include the LDAP:\\\\ prefix, only the server’s domain name or IP address. |
| Port | Specifies the port number on which the LDAP server is running. |
| User | Specifies the distinguished name (DN) of the user account to be used for authentication with the LDAP server. This property is required when the server enforces authentication. |
| Password | Specifies the password associated with the distinguished name (DN) of the user account used for authentication with the LDAP server. This property is required when the server enforces authentication. |
| BaseDN | Specifies the base portion of the distinguished name (DN) to limit LDAP queries to a specific subtree within the directory. Using a base DN helps narrow the search scope and improve query performance, especially on large LDAP servers. |
| 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 | Specifies the version of the LDAP protocol to use when connecting to the server. The supported values are 2 and 3. |
| AuthMechanism | Specifies the authentication mechanism to use when connecting to the LDAP server. Supported values are SIMPLE for plaintext authentication and NEGOTIATE for NTLM/Negotiate authentication. |
| Scope | Specifies the scope of the LDAP search. This property defines whether the search applies to the entire subtree (BaseDN and all its descendants), a single level (BaseDN and its direct descendants), or just the base object (BaseDN only). |
| 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. |
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.
string
"Static"
The sche.
Specifies the domain name or IP address of the LDAP server. This property is required to establish a connection and does not need to include the LDAP:\\\\ prefix, only the server’s domain name or IP address.
string
""
This property defines the LDAP server's location and must be set to either a domain name like "ldap.example.com" or an IP address such as 192.168.1.1. Do not include the LDAP:\\ prefix, as the provider handles it automatically.
Specifies the port number on which the LDAP server is running.
string
"389"
This property defines the port the LDAP server is running on. By default, it is set to 389, which is the standard port for LDAP. Together with the Server property, this property determines the full connection endpoint. If your LDAP server is configured to use a non-standard port, update this property accordingly.
Specifies the distinguished name (DN) of the user account to be used for authentication with the LDAP server. This property is required when the server enforces authentication.
string
""
This property is used, along with the Password property, to authenticate against the LDAP server. The value must be the full distinguished name (DN) of the user account, such as "CN=John Doe,OU=Users,DC=example,DC=com". Ensure the value matches the DN format expected by the LDAP server to avoid authentication failures.
Specifies the password associated with the distinguished name (DN) of the user account used for authentication with the LDAP server. This property is required when the server enforces authentication.
string
""
This property is used in conjunction with the User property to authenticate against the LDAP server. Ensure the password corresponds to the specified distinguished name (DN) to avoid authentication failures. For enhanced security, ensure the password is not hardcoded in configuration files. Instead, use environment variables or secure credential storage to handle sensitive values when configuring LDAP authentication.
Specifies the base portion of the distinguished name (DN) to limit LDAP queries to a specific subtree within the directory. Using a base DN helps narrow the search scope and improve query performance, especially on large LDAP servers.
string
""
This property sets the starting point for LDAP searches by specifying the base DN. By limiting the search to a specific subtree, the number of entries examined is significantly reduced, which can greatly improve performance on large servers. The value should be a valid DN, such as "DC=example,DC=com", that represents the desired subtree. If left blank, the search scope is not restricted and applies to the entire directory.
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.
bool
false
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:
If the Cloud connects to an encrypted endpoint, SSL is automatically used regardless of the value of this property. Ensure that your LDAP server supports SSL if you enable this property.
Specifies the version of the LDAP protocol to use when connecting to the server. The supported values are 2 and 3.
string
"2"
Set this property to specify the LDAP protocol version used for communication. The default value is 2, but many modern LDAP servers require version 3 for compatibility. Ensure that the server you are connecting to supports the specified version to avoid communication errors. The provider complies with LDAP standards as specified in RFC 1777, RFC 2251, and other relevant LDAP RFCs.
Specifies the authentication mechanism to use when connecting to the LDAP server. Supported values are SIMPLE for plaintext authentication and NEGOTIATE for NTLM/Negotiate authentication.
string
"SIMPLE"
This property specifies the method of authentication to use during connection. The default value is SIMPLE, which uses plaintext credentials to authenticate with the server. If set to NEGOTIATE, NTLM/Negotiate authentication is used, enabling support for Windows-based integrated authentication. Ensure the LDAP server supports the specified authentication mechanism. Use NEGOTIATE for environments that require secure, integrated authentication, while SIMPLE is suitable for scenarios where plaintext credentials are accepted.
Specifies the scope of the LDAP search. This property defines whether the search applies to the entire subtree (BaseDN and all its descendants), a single level (BaseDN and its direct descendants), or just the base object (BaseDN only).
string
"WHOLESUBTREE"
This property is useful for balancing performance and query results. For broad searches that require retrieving entries across the entire directory hierarchy, use WHOLESUBTREE. For more focused queries, select SINGLELEVEL to limit results to the BaseDN’s direct descendants or BASEOBJECT to retrieve only the BaseDN itself. Narrowing the search scope can help reduce unnecessary overhead and improve query efficiency, especially in large directories.
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.
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.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space- or colon-separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space- or colon-separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
string
"1"
This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.
The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.
When combined with the LogModules property, Verbosity can refine logging to specific categories of information.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
string
""
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| FollowReferrals | Specifies whether to follow LDAP referrals returned by the LDAP server. When enabled, the provider retrieves data from the referred servers instead of the original server. |
| 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 | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| ThrowsKeyNotFound | Specifies whether or not throws an exception if there is no rows updated. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
Specifies whether to follow LDAP referrals returned by the LDAP server. When enabled, the provider retrieves data from the referred servers instead of the original server.
bool
false
This property specifies whether the provider should follow referrals returned by the LDAP server during queries. Referrals are pointers to other LDAP servers that may contain the requested data. When FollowReferrals is set to true, the provider connects to the referral servers to retrieve data. Note that data operations such as INSERT, UPDATE, or DELETE cannot be performed on referral servers unless the connection string is updated to connect directly to those servers.
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.
bool
false
This property specifies how GUID attributes, such as objectGUID, are returned when inspecting object attributes. If set to true, GUIDs are converted into a human-readable string format. If set to false, GUIDs are returned as base64-encoded binary objects. The friendly string format makes GUID values easier to interpret and work with during debugging or when creating readable reports. This property is useful in scenarios where GUIDs need to be reviewed manually or shared in a clear, human-readable format.
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.
bool
false
This property specifies how SID attributes, such as objectSid, are returned when inspecting object attributes. If set to true, SIDs are converted into a human-readable string format. If set to false, SIDs are returned as base64-encoded binary objects. The friendly string format simplifies working with SID values, making them easier to interpret during debugging or when generating reports. This property is useful in scenarios where SIDs need to be reviewed manually or shared in a clear, human-readable format.
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
int
-1
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
string
""
This property allows you to define which pseudocolumns the Cloud exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
Specifies whether or not throws an exception if there is no rows updated.
bool
false
Specifies whether or not throws an exception if there is no rows updated.
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
int
60
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
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
All rights reserved.
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.