h1. {color:#000000}{*}LDAP Translator{*}{color} |
A Translator is typically paired with a particular JCA resource adapter. In instances where pooling, environment dependent configuration management, advanced security handling, etc. are not needed, then a JCA resource adapter is not needed. The configuration of JCA ConnectionFactories for needed resource adapters is not part of this guide, please see the Teiid Administrator Guide and the kit examples for configuring resource adapters for use in JBossAS. |
|
{color:#333333}The LDAP translator, known by the type name {color}{color:#333333}{_}ldap{_}{color}{color:#333333}, exposes an LDAP directory tree relationally with pushdown support for filtering via criteria. This is typically coupled with the LDAP resource adapter.{color} |
Translators can have a number of configurable properties. These are broken down into execution properties, which determine aspects of how data is retrieved, and import settings, which determine what metadata is read for import. |
|
{color:#333333}{*}Execution Properties{*}{color}{color:#333333} {color} || {color:#000000}Name{color} || {color:#000000}Description{color} || {color:#000000}Default{color} || | {color:#333333}SearchDerfaultBaseDN{color} | {color:#333333}Default Base DN for LDAP Searches{color} | {color:#333333}null{color} | | {color:#333333}SearchDefaultScope{color} | {color:#333333}Default Scope for LDAP Searches. Can be one of SUBTREE_SCOPE, OBJECT_SCOPE, ONELEVEL_SCOPE.{color} | {color:#333333}ONELEVEL_SCOPE{color} | | {color:#333333}RestrictToObjectClass{color} | {color:#333333}Restrict Searches to objectClass named in the Name field for a table{color} | {color:#333333}false{color} | | {color:#333333}UsePagination{color} | {color:#333333}Use a PagedResultsControl to page through large results. This is not supported by all directory servers.{color} | {color:#333333}false{color} | | {color:#333333}ExceptionOnSizeLimitExceeded{color} | {color:#333333}Set to true to throw an exception when a SizeLimitExceededException is received and a LIMIT is not properly enforced.{color} | {color:#333333}false{color} | {color:#333333}There are no import settings for the ldap translator; it also does not provide metadata.{color} |
The execution properties for a translator typically have reasonable defaults. For specific translator types, e.g. the Derby translator, base execution properties are already tuned to match the source. In most cases the user will not need to adjust their values. |
|
h3. {color:#000000}{*}Metadata Directives{*}{color} |
*Base Execution Properties - shared by all translators* || Name || Description || Default || | Immutable | Set to true to indicate that the source never changes. | false | | RequiresCriteria | Set to true to indicate that source SELECT/UPDATE/DELETE queries require a where clause. | false | | SupportsOrderBy | Set to true to indicate that the ORDER BY clause is supported. | false | | SupportsOuterJoins | Set to true to indicate that OUTER JOINs are supported. | false | | SupportsFullOuterJoins | If outer joins are supported, true indicates that FULL OUTER JOINs are supported. | false | | SupportsInnerJoins | Set to true to indicate that INNER JOINs are supported. | false | | SupportedJoinCriteria | If joins are supported, defines what criteria may be used as the join criteria. May be one of (ANY, THETA, EQUI, or KEY). | ANY | | MaxInCriteriaSize | If in criteria are supported, defines what the maximum number of in entries are per predicate. \-1 indicates no limit. | \-1 | | MaxDependentInPredicates | If in criteria are supported, defines what the maximum number of predicates that can be used for a dependent join. Values less than 1 indicate to use only one in predicate per dependent value pushed (which matches the pre-7.4 behavior). | \-1 | | NativeQueryProcedureName | if the native query is supported on the translator, this property indicates the name of the procedure. | native | | SupportsNativeQueries | Set to true to indicate the translator supports the direct execution of commands using the *native* procedure | false | \\ |
|
{color:#333333}String columns with a default value of "multivalued-concat" will concatinate all attribute values together in alphabetical order using a ? delimiter. If a multivalued attribute does not have a default value of "multivalued-concat", then any value may be returned.{color} h3. {color:#000000}{*}Native Queries{*}{color} {color:#333333}LDAP procedures may optionally have native queries associated with them - see {color}[Parameterizable Native Queries|Built-in Translators#native]. The operation prefix (select;, insert;, update;, delete; - see the native procedure logic below for more) must be present in the native-query, but it will not be issued as part of the query to the source. {code:sql|title=Example DDL for an LDAP native procedure} CREATE FOREIGN PROCEDURE proc (arg1 integer, arg2 string) OPTIONS ("teiid_rel:native-query" 'search;context-name=corporate;filter=(&(objectCategory=person)(objectClass=user)(!cn=$2));count-limit=5;timeout=$1;search-scope=ONELEVEL_SCOPE;attributes=uid,cn') returns (col1 string, col2 string); {code} |
{note}Only a subset of the supports metadata can be set through execution properties. If more control is needed, please consult the [Developer's Guide]. |
{note} |
{color:#333333}Parameter values have reserved characters escaped, but are otherwise directly substituted into the query.{color}{note} |
|
h4. {color:#000000}{*}Native Procedure{*}{color} {warning} {color:#333333}This feature is turned off by default because of the security risk this exposes to execute any command against the source. To enable this feature, override the translator property called "SupportsNativeQueries" to true. Look for {color}[Override Execution Properties|Built-in Translators#Override Execution Properties] above.{warning} {color:#333333}LDAP translator provides a procedure with name {color}{color:#333333}{*}native{*}{color}{color:#333333} that gives ability to execute any ad-hoc native LDAP queries directly against the source without any Teiid parsing or resolving. The metadata of this procedure's execution results are not known to the Teiid, and they are returned as object array. User can use {color}[ARRAYTABLE] construct to build tabular output for consumption by client applications. Since there is no known direct query language for LDAP, Teiid exposes this procedure with a simple query structure as below |
There are no base importer settings. |
|
h5. {color:#000000}{*}Search{*}{color} {code:lang=SQL|title=Search Example} SELECT x.* FROM (call pm1.native('search;context-name=corporate;filter=(objectClass=*);count-limit=5;timeout=6;search-scope=ONELEVEL_SCOPE;attributes=uid,cn')) w, ARRAYTABLE(w.tuple COLUMNS "uid" string , "cn" string) AS x {code} {color:#333333}from the above code, the "{color}{color:#333333}{*}search{*}{color}{color:#333333}" keyword followed by below properties. Each property must be delimited by semi-colon (\;) If a property contains a semi-colon (\;), it should be escaped by another semi-colon - see also{color}[Parameterizable Native Queries|Built-in Translators#native] and the native-query procedure example above. || {color:#000000}Name{color} || {color:#000000}Description{color} || {color:#000000}Required{color} || | {color:#333333}context-name{color} | {color:#333333}LDAP Context name{color} | {color:#333333}Yes{color} | | {color:#333333}filter{color} | {color:#333333}query to filter the records in the context{color} | {color:#333333}No{color} | | {color:#333333}count-limit{color} | {color:#333333}limit the number of results. same as using LIMIT{color} | {color:#333333}No{color} | | {color:#333333}timeout{color} | {color:#333333}Time out the query if not finished in given milliseconds{color} | {color:#333333}No{color} | | {color:#333333}search-scope{color} | {color:#333333}LDAP search scope, one of SUBTREE_SCOPE, OBJECT_SCOPE, ONELEVEL_SCOPE{color} | {color:#333333}No{color} | | {color:#333333}attributes{color} | {color:#333333}attributes to retrieve{color} | {color:#333333}Yes{color} | |
h3. Override Execution Properties |
|
h5. {color:#000000}{*}Delete{*}{color} {code:lang=SQL|title=Delete Example} SELECT x.* FROM (call pm1.native('delete;uid=doe,ou=people,o=teiid.org')) w, ARRAYTABLE(w.tuple COLUMNS "updatecount" integer) AS x {code} {color:#333333}form the above code, the "{color}{color:#333333}{*}delete{*}{color}{color:#333333}" keyword followed the "DN" string. All the string contents after the "delete;" used as DN.{color} |
For all the translators to override Execution Properties can be configured in the _vdb.xml_ file. |
|
h5. {color:#000000}{*}Create or Update{*}{color} {code:lang=SQL|title=Create Example} SELECT x.* FROM (call pm1.native('create;uid=doe,ou=people,o=teiid.org;attributes=one,two,three', 'one', 2, 3.0)) w, ARRAYTABLE(w.tuple COLUMNS "update_count" integer) AS x |
{code:XML|title=Example Overriding of Translator Property} <translator type="oracle-override" name="oracle"> <property value="RequiresCriteria" name="true"/> </translator> |
{code} |
{color:#333333}form the above code, the "{color}{color:#333333}{*}create{*}{color}{color:#333333}" keyword followed the "DN" string. All the string contents after the "create;" is used as DN. It also takes one property called "attributes" which is comma separated list of attributes. The values for each attribute is specified as separate argument to the "native" procedure.{color} |
|
{color:#333333}Update is similar to create{color} {code:lang=SQL|title=Update Example} SELECT x.* FROM (call pm1.native('update;uid=doe,ou=people,o=teiid.org;attributes=one,two,three', 'one', 2, 3.0)) w, ARRAYTABLE(w.tuple COLUMNS "update_count" integer) AS x {code} {info:tip=Name of the Native Procedure} {color:#333333}By default the name of the procedure that executes the queries directly is called {color}{color:#333333}{*}native{*}{color}{color:#333333}, however than can{color} {color:#333333}be set via an override execution property in the vdb.xml file.{color}{info} |
The above XML fragment is overriding the _oracle_ translator and altering the behavior of _RequiresCriteria_ property to true. Note that the modified translator is only available in the scope of this VDB. |
|
h3. {color:#000000}{*}JCA Resource Adapter{*}{color} |
h3. {anchor:native}Parameterizable Native Queries |
|
{color:#333333}The resource adapter for this translator provided through "LDAP Data Source", Refer to Admin Guide for configuration.{color} |
In some situations the teiid_rel:native-query property and native procedures accept parameterizable strings that can positionally reference IN parameters. A parameter reference has the form $integer, i.e. $1 Note that 1 based indexing is used and that only IN parameters may be referenced. Dollar-sign integer is therefore reserved, but may be escaped with another $, i.e. $$1. The value will be bound as a prepared value or a literal is a source specific manner. The native query must return a result set that matches the expectation of the calling procedure. For example the native-query "select c from g where c1 = $1 and c2 = '$$1'" results in a JDBC source query of "select c from g where c1 = ? and c2 = '$1'", where ? will be replaced with the actual value bound to parameter 1. |
A Translator is typically paired with a particular JCA resource adapter. In instances where pooling, environment dependent configuration management, advanced security handling, etc. are not needed, then a JCA resource adapter is not needed. The configuration of JCA ConnectionFactories for needed resource adapters is not part of this guide, please see the Teiid Administrator Guide and the kit examples for configuring resource adapters for use in JBossAS.
Translators can have a number of configurable properties. These are broken down into execution properties, which determine aspects of how data is retrieved, and import settings, which determine what metadata is read for import.
The execution properties for a translator typically have reasonable defaults. For specific translator types, e.g. the Derby translator, base execution properties are already tuned to match the source. In most cases the user will not need to adjust their values.
Base Execution Properties - shared by all translators
Name | Description | Default |
---|---|---|
Immutable | Set to true to indicate that the source never changes. | false |
RequiresCriteria | Set to true to indicate that source SELECT/UPDATE/DELETE queries require a where clause. | false |
SupportsOrderBy | Set to true to indicate that the ORDER BY clause is supported. | false |
SupportsOuterJoins | Set to true to indicate that OUTER JOINs are supported. | false |
SupportsFullOuterJoins | If outer joins are supported, true indicates that FULL OUTER JOINs are supported. | false |
SupportsInnerJoins | Set to true to indicate that INNER JOINs are supported. | false |
SupportedJoinCriteria | If joins are supported, defines what criteria may be used as the join criteria. May be one of (ANY, THETA, EQUI, or KEY). | ANY |
MaxInCriteriaSize | If in criteria are supported, defines what the maximum number of in entries are per predicate. -1 indicates no limit. | -1 |
MaxDependentInPredicates | If in criteria are supported, defines what the maximum number of predicates that can be used for a dependent join. Values less than 1 indicate to use only one in predicate per dependent value pushed (which matches the pre-7.4 behavior). | -1 |
NativeQueryProcedureName | if the native query is supported on the translator, this property indicates the name of the procedure. | native |
SupportsNativeQueries | Set to true to indicate the translator supports the direct execution of commands using the native procedure | false |
Only a subset of the supports metadata can be set through execution properties. If more control is needed, please consult the Developer's Guide. |
There are no base importer settings.
For all the translators to override Execution Properties can be configured in the vdb.xml file.
<translator type="oracle-override" name="oracle"> <property value="RequiresCriteria" name="true"/> </translator>
The above XML fragment is overriding the oracle translator and altering the behavior of RequiresCriteria property to true. Note that the modified translator is only available in the scope of this VDB.
In some situations the teiid_rel:native-query property and native procedures accept parameterizable strings that can positionally reference IN parameters. A parameter reference has the form $integer, i.e. $1 Note that 1 based indexing is used and that only IN parameters may be referenced. Dollar-sign integer is therefore reserved, but may be escaped with another $, i.e. $$1. The value will be bound as a prepared value or a literal is a source specific manner. The native query must return a result set that matches the expectation of the calling procedure.
For example the native-query "select c from g where c1 = $1 and c2 = '$$1'" results in a JDBC source query of "select c from g where c1 = ? and c2 = '$1'", where ? will be replaced with the actual value bound to parameter 1.