6.2. VDB Definition: The VDB Element

Attributes

• name
  The name of the VDB. The VDB name referenced through the driver or datasource during the connection time.
• version
  The version of the VDB (should be an positive integer). This determines the deployed directory location (see Name), and provides an explicit versioning mechanism to the VDB name.

Property Elements

• cache-metadata
  Can be "true" or "false". If "false", JBoss Data Virtualization will obtain metadata once for every launch of the VDB. "true" will save a file containing the metadata into the EAP_HOME/MODE/data directory. Defaults to "false" for -vdb.xml deployments otherwise "true".
• 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. See also Support for Non-Pushdown User Defined Functions in Red Hat JBoss Data Virtualization Development Guide: Server Development.
• 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" />
  

  Important

  An administrator needs to configure a matching "custom-security" login module in the standalone.xml configuration file before the VDB is deployed.
• connection.XXX
  This is for use by the ODBC transport and OData. They use it to set the default connection/execution properties. Note that the properties are set on the connection after it has been established.

  <property name="connection.partialResultsMode" value="true" />
  

• authentication-type
  Authentication type of configured security domain. Allowed values currently are (GSS, USERPASSWORD). The default is set on the transport (typically USERPASSWORD).
• password-pattern
  Regular expression matched against the connecting user's name that determines if USERPASSWORD authentication is used. password-pattern Takes precedence of over authentication-type. The default is authentication-type.
• gss-pattern
  Regular expression matched against the connecting user's name that determines if GSS authentication is used. gss-pattern Takes precedence of over password-pattern. The default is password-pattern.
• 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, PG metadata is always added to VDB unless System Properties set property org.teiid.addPGMetadata to false. This property enables adding PG metadata per VDB. 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. Setting lazy-invalidate to true makes ttl refreshes non-invalidating.