Virtual database properties

DATABASE properties
  • domain-ddl

  • schema-ddl

  • cache-metadata

Can be true or false. Defaults to `false for -vdb.xml deployments otherwise true. If false, Teiid will obtain metadata once for every launch of the virtual database. true will save a file containing the metadata into the PROFILE/data/teiid directory.

  • query-timeout Sets the default query timeout in milliseconds for queries executed against this VDB. 0 indicates that the server default query timeout should be used. Defaults to 0. Will have no effect if the server default query timeout is set to a lesser value. Note that clients can still set their own timeouts that will be managed on the client side.

  • lib Set to a list of modules for the vdb classpath for user defined function loading. For more information, see Support for User-Defined Functions (Non-Pushdown) in the Translator Development Guide.

  • security-domain Set to the security domain to use if a specific security domain is applicable to the VDB. Otherwise the security domain list from the transport will be used.

   <property name="security-domain" value="custom-security" />
An admin needs to configure a matching "custom-security" login module in standalone-teiid.xml configuration file before the VDB is deployed.
  • connection.XXX For use by the ODBC transport and OData to set default connection/execution properties. For more information about related properties, see Driver Connection in the Client Developer’s Guide. Note these are set on the connection after it has been established.

CREATE DATABASE vdb OPTIONS ("connection.partialResultsMode" true);
   <property name="connection.partialResultsMode" value="true" />
  • authentication-type

Authentication type to be used with this VDBs security domain. Allowed values currently are (GSS, USERPASSWORD, SSL). The default is set on the session service (typically USERPASSWORD).

  • Authentication Patterns

    Authentication patterns further control the expected authentication using the user name given with the connection attempt.


    Regular expression matched against the connecting user’s name that determines if USERPASSWORD authentication is used. password-pattern takes precedence over authentication-type.


    Regular expression matched against the connecting user’s name that determines if SSL authentication is used. ssl-pattern takes precedence over password-pattern.


    Regular expression matched against the connecting user’s name that determines if GSS authentication is used. gss-pattern takes precedence over ssl-pattern.

  • max-sessions-per-user (11.2+)

Maximum number of sessions allowed for each user, as identified by the user name, of this VDB. No setting or a negative number indicates no per user max, but the session service max will still apply. This is enforced at each Teiid server member in a cluster, and not cluster wide. Derived sessions that are created for tasks under an existing session do not count against this maximum.

  • model.visible

Used to override the visibility of imported vdb models, where model is the name of the imported model.

  • include-pg-metadata

By default, PostgreSQL metadata is always added to VDB unless you set the property org.teiid.addPGMetadata to false. This property enables adding PG metadata per VDB. For more information, System Properties in the Administrator’s Guide. Please note that if you are using ODBC to access your VDB, the VDB must include PG metadata.

  • lazy-invalidate

By default TTL expiration will be invalidating. For more information, see Internal Materialization in the Caching guide. Setting lazy-invalidate to true will make TTL refreshes non-invalidating.

  • deployment-name

Effectively reserved. Will be set at deploy time by the server to the name of the server deployment.

Schema and model properties
  • visible

Marks the schema as visible when the value is true (the default setting). When the visible flag is set to false, the schema’s metadata is hidden from any metadata requests. Setting the property to false does not prohibit you from issuing queries against this schema. For information about how to control access to data, see Data roles.

  • multisource

Sets the schema to multi-source mode, where the data exists in partitions in multiple different sources. It is assumed that metadata of the schema is the same across all data sources.

  • multisource.columnName

In a multi-source schema, an additional column that designates the partition is implicitly added to all tables to identify the source. This property defines the name of that column, the type will be always String.

  • multisource.addColumn

This flag specifies to add an implicit partition column to all the tables in this schema. A true value adds the column. Default is false.

  • allowed-languages

Specifies a comma-separated list of programming languages that can be used for any purpose in the VDB. Names are case-sensitive, and the list cannot include whitespace between entries. For example, <property name="allowed-languages" value="javascript"/>

  • allow-language Specifies that a role has permission to use a language that is listed in the allowed-languages property. For example, the allow-language property in following excerpt specifies that users with the role RoleA have permission to use Javascript.

<data-role name="RoleA">
        <description>Read and javascript access.</description>





results matching ""

    No results matching ""