element <dat:table>
Namespace:
http://labkey.org/data/xml
Type:
dat:TableType
Content:
complex, 4 attributes, 28 elements
Defined:
locally within complexType dat:TablesType in tableInfo.xsd, see XML source
XML Representation Summary
<dat:table
    hidden
 = 
 xs:boolean : "false"
    tableDbType
 = 
 xs:string
    tableName
 = 
 xs:string
    useColumnOrder
 = 
 xs:boolean : "false"
    >
   
Content: 
 (dat:includeColumnsList? × dat:tableTitle? × dat:description? × dat:tableGroup? × dat:manageTableAllowed? × dat:dbTableName? × dat:manageTables? × dat:nextStep? × dat:pkColumnName? × dat:versionColumnName? × dat:gridUrl? × dat:importUrl? × dat:insertUrl? × dat:deleteUrl? × dat:updateUrl? × dat:tableUrl? × dat:titleColumn? × dat:cacheSize? × dat:importMessage? × dat:importTemplates? × dat:columns? × dat:indices? × dat:viewOptions? × dat:buttonBarOptions? × dat:aggregateRowOptions? × dat:javaCustomizer? × dat:auditLogging? × dat:filters?)?
</dat:table>
Content model elements (28):
dat:aggregateRowOptions (type dat:AggregateRowOptions),
dat:auditLogging (type dat:AuditType),
dat:buttonBarOptions (type dat:ButtonBarOptions),
dat:cacheSize (type xs:int),
dat:columns (type anonymous),
dat:dbTableName (type xs:string),
dat:deleteUrl (type dat:StringExpressionType),
dat:description (type xs:string),
dat:filters (type cv:localOrRefFiltersType),
dat:gridUrl (type dat:StringExpressionType),
dat:importMessage (type xs:string),
dat:importTemplates (type anonymous),
dat:importUrl (type dat:StringExpressionType),
dat:includeColumnsList (type xs:string),
dat:indices (type dat:IndicesType),
dat:insertUrl (type dat:StringExpressionType),
dat:javaCustomizer (type dat:TableCustomizerType),
dat:manageTableAllowed (type xs:boolean),
dat:manageTables (type xs:string),
dat:nextStep (type xs:string),
dat:pkColumnName (type xs:string),
dat:tableGroup (type xs:string),
dat:tableTitle (type xs:string),
dat:tableUrl (type dat:StringExpressionType),
dat:titleColumn (type xs:string),
dat:updateUrl (type dat:StringExpressionType),
dat:versionColumnName (type xs:string),
dat:viewOptions (type dat:ViewOptions)
Included in content model of elements (2):
dat:tables,
dat:tables (in esd:metadata)
Definition Locations
XML Source (see within schema source)
<xs:element name="table" type="dat:TableType">
<xs:unique name="uniqueColumns">
<xs:selector xpath="./dat:columns/dat:column"/>
<xs:field xpath="@columnName"/>
</xs:unique>
</xs:element>
Attribute Detail
hidden
Type:
xs:boolean, predefined
Use:
optional
Default:
"false"
Defined:
locally, within dat:TableType complexType
When true, hide the table from the list of tables in the Query drop down and schema browser. Queries or lookups using columns from this table will still resolve. Supported for external schema tables and module tables.
XML Source (see within schema source)
<xs:attribute default="false" name="hidden" type="xs:boolean">
<xs:annotation>
<xs:documentation>
When true, hide the table from the list of tables in the Query drop down and schema browser. Queries or lookups using columns from this table will still resolve.
Supported for external schema tables and module tables.
</xs:documentation>
</xs:annotation>
</xs:attribute>
tableDbType
Type:
anonymous (restriction of xs:string)
Use:
required
Defined:
locally, within dat:TableType complexType
The four recognized values for the tableDbType attribute are TABLE, VIEW, NOT_IN_DB, UNKNOWN. The TABLE and VIEW values correspond to their SQL definitions. NOT_IN_DB type is used for objects that are defined by SQL strings in code, rather than by named objects in the database. UNKNOWN is used in cases where the type differs between database types. Supported for SQL metadata.
Anonymous simpleType
Derivation:
restriction of xs:string
Facets:
pattern:
 TABLE|VIEW|NOT_IN_DB|UNKNOWN
XML Source (see within schema source)
<xs:attribute name="tableDbType" use="required">
<xs:annotation>
<xs:documentation>
The four recognized values for the tableDbType attribute are TABLE, VIEW, NOT_IN_DB, UNKNOWN.
The TABLE and VIEW values correspond to their SQL definitions.
NOT_IN_DB type is used for objects that are defined by SQL strings in code, rather than by named objects in the database.
UNKNOWN is used in cases where the type differs between database types.
Supported for SQL metadata.
</xs:documentation>
</xs:annotation>
<xs:simpleType>
<xs:restriction base="xs:string">
<xs:pattern value="TABLE|VIEW|NOT_IN_DB|UNKNOWN"/>
</xs:restriction>
</xs:simpleType>
</xs:attribute>
tableName
Type:
xs:string, predefined
Use:
required
Defined:
locally, within dat:TableType complexType
The name attribute is required, and corresponds in a case-insensitive way to the name of the object in the database, not including schema or catalog qualifiers. The schema qualifier for a table object is determined by the registerProvider method of the DefaultSchema. Used for dataset import/export and list import/export.
XML Source (see within schema source)
<xs:attribute name="tableName" type="xs:string" use="required">
<xs:annotation>
<xs:documentation>
The name attribute is required, and corresponds in a case-insensitive way to the name of the object
in the database, not including schema or catalog qualifiers. The schema qualifier for a table object
is determined by the registerProvider method of the DefaultSchema. Used for dataset import/export and
list import/export.
</xs:documentation>
</xs:annotation>
</xs:attribute>
useColumnOrder
Type:
xs:boolean, predefined
Use:
optional
Default:
"false"
Defined:
locally, within dat:TableType complexType
If set to true, the columns will be presented in the order in which they are specified in the XML. Any columns in the underlying query/table that are not included in the XML will be kept in their original order and listed after the columns that are included in the XML. If set to false, the columns will be shown based on their "natural" order as determined by the underlying database.
XML Source (see within schema source)
<xs:attribute default="false" name="useColumnOrder" type="xs:boolean">
<xs:annotation>
<xs:documentation>
If set to true, the columns will be presented in the order in which they are specified in the XML.
Any columns in the underlying query/table that are not included in the XML will be kept in their
original order and listed after the columns that are included in the XML. If set to false,
the columns will be shown based on their "natural" order as determined by the underlying database.
</xs:documentation>
</xs:annotation>
</xs:attribute>
Content Element Detail
dat:aggregateRowOptions
Type:
dat:AggregateRowOptions, empty content
Defined:
locally, within dat:TableType complexType
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="aggregateRowOptions" type="dat:AggregateRowOptions"/>
dat:auditLogging
Type:
dat:AuditType, simple content
Defined:
locally, within dat:TableType complexType
Defaults to 'NONE'. Determines the level of auditing on this table for insert, update, and delete operations. Other options are 'SUMMARY' and 'DETAILED'.
XML Source (see within schema source)
<xs:element minOccurs="0" name="auditLogging" type="dat:AuditType">
<xs:annotation>
<xs:documentation>
Defaults to 'NONE'. Determines the level of auditing on this table for insert, update, and
delete operations. Other options are 'SUMMARY' and 'DETAILED'.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:buttonBarOptions
Type:
dat:ButtonBarOptions, complex content
Defined:
locally, within dat:TableType complexType
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="buttonBarOptions" type="dat:ButtonBarOptions"/>
dat:cacheSize
Type:
xs:int, predefined, simple content
Defined:
locally, within dat:TableType complexType
Optional maximum number of items from this table to cache in the application. Supported for external schema tables and module tables.
XML Source (see within schema source)
<xs:element minOccurs="0" name="cacheSize" type="xs:int">
<xs:annotation>
<xs:documentation>
Optional maximum number of items from this table to cache in the application.
Supported for external schema tables and module tables.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:columns
Type:
anonymous, complex content
Defined:
locally, within dat:TableType complexType
The collection of column objects within this table object. Used for dataset import/export and list import/export.
XML Source (see within schema source)
<xs:element minOccurs="0" name="columns">
<xs:annotation>
<xs:documentation>
The collection of column objects within this table object. Used for dataset import/export and list import/export.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence maxOccurs="unbounded" minOccurs="0">
<xs:element name="column" type="dat:ColumnType"/>
</xs:sequence>
</xs:complexType>
</xs:element>
dat:dbTableName
Type:
xs:string, predefined, simple content
Defined:
locally, within dat:TableType complexType
Not currently used.
XML Source (see within schema source)
<xs:element minOccurs="0" name="dbTableName" type="xs:string">
<xs:annotation>
<xs:documentation>Not currently used.</xs:documentation>
</xs:annotation>
</xs:element>
dat:deleteUrl
Type:
dat:StringExpressionType, simple content
Defined:
locally, within dat:TableType complexType
URL string expression used to render the default delete link for this table. May be set to a blank value to prevent a table's default URL from being used. Do not include key values as substitutions, they will automatically be POSTed. see ColumnType.url.
XML Source (see within schema source)
<xs:element minOccurs="0" name="deleteUrl" type="dat:StringExpressionType">
<xs:annotation>
<xs:documentation>
URL string expression used to render the default delete link for this table. May be set to
a blank value to prevent a table's default URL from being used. Do not include key values as
substitutions, they will automatically be POSTed. see ColumnType.url.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:description
Type:
xs:string, predefined, simple content
Defined:
locally, within dat:TableType complexType
A description of the meaning of the table. Used in dataset import/export and list import/export.
XML Source (see within schema source)
<xs:element minOccurs="0" name="description" type="xs:string">
<xs:annotation>
<xs:documentation>
A description of the meaning of the table. Used in dataset import/export and list import/export.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:filters
Type:
cv:localOrRefFiltersType, complex content
Defined:
locally, within dat:TableType complexType
Apply filters to the table underlying table. Only applicable to external schema tables, linked schema tables, and query metadata overrides (??). Filter may be defined locally or by reference to a filter defined in the <tables> element.
XML Source (see within schema source)
<xs:element minOccurs="0" name="filters" type="cv:localOrRefFiltersType">
<xs:annotation>
<xs:documentation>
Apply filters to the table underlying table.
Only applicable to external schema tables, linked schema tables, and query metadata overrides (??).
Filter may be defined locally or by reference to a filter defined in the &lt;tables&gt; element.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:gridUrl
Type:
dat:StringExpressionType, simple content
Defined:
locally, within dat:TableType complexType
URL string expression used to render the default grid view link for this table. see ColumnType.url.
XML Source (see within schema source)
<xs:element minOccurs="0" name="gridUrl" type="dat:StringExpressionType">
<xs:annotation>
<xs:documentation>
URL string expression used to render the default grid view link for this table. see ColumnType.url.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:importMessage
Type:
xs:string, predefined, simple content
Defined:
locally, within dat:TableType complexType
A message that will be displayed on the default import page and will be appended to the top of the default excel import template.
XML Source (see within schema source)
<xs:element minOccurs="0" name="importMessage" type="xs:string">
<xs:annotation>
<xs:documentation>
A message that will be displayed on the default import page and will be appended to the top of the default
excel import template.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:importTemplates
Type:
anonymous, complex content
Defined:
locally, within dat:TableType complexType
A list of import templates that will be available for download on the default excel upload page. Each template can have a label and a URL. This should should either point to a static file or an action that will generate the template.
XML Source (see within schema source)
<xs:element minOccurs="0" name="importTemplates">
<xs:annotation>
<xs:documentation>
A list of import templates that will be available for download on the default excel upload page.
Each template can have a label and a URL. This should should either point to a static file or an action that
will generate the template.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence maxOccurs="unbounded" minOccurs="0">
<xs:element name="template" type="dat:ImportTemplateType"/>
</xs:sequence>
</xs:complexType>
</xs:element>
dat:importUrl
Type:
dat:StringExpressionType, simple content
Defined:
locally, within dat:TableType complexType
URL string expression used to render the import data link for this table. see ColumnType.url.
XML Source (see within schema source)
<xs:element minOccurs="0" name="importUrl" type="dat:StringExpressionType">
<xs:annotation>
<xs:documentation>
URL string expression used to render the import data link for this table. see ColumnType.url.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:includeColumnsList
Type:
xs:string, predefined, simple content
Defined:
locally, within dat:TableType complexType
For linked schemas only: Columns to be included by name in linked tables. This is a comma separated list of column names.
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="includeColumnsList" type="xs:string">
<xs:annotation>
<xs:documentation>
For linked schemas only: Columns to be included by name in linked tables. This is a comma separated list of column names.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:indices
Type:
dat:IndicesType, complex content
Defined:
locally, within dat:TableType complexType
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="indices" type="dat:IndicesType"/>
dat:insertUrl
Type:
dat:StringExpressionType, simple content
Defined:
locally, within dat:TableType complexType
URL string expression used to render the default insert view link for this table. May be set to a blank value to prevent a table's default URL from being used. see ColumnType.url.
XML Source (see within schema source)
<xs:element minOccurs="0" name="insertUrl" type="dat:StringExpressionType">
<xs:annotation>
<xs:documentation>
URL string expression used to render the default insert view link for this table. May be set to
a blank value to prevent a table's default URL from being used. see ColumnType.url.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:javaCustomizer
Type:
dat:TableCustomizerType, mixed content
Defined:
locally, within dat:TableType complexType
An implementation of org.labkey.api.data.TableCustomizer. Must have a no-argument constructor. The value should be the fully qualified Java class name. Used to allow further customization of the table and its columns via Java code.
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="javaCustomizer" type="dat:TableCustomizerType">
<xs:annotation>
<xs:documentation>
An implementation of org.labkey.api.data.TableCustomizer. Must have a no-argument constructor.
The value should be the fully qualified Java class name.
Used to allow further customization of the table and its columns via Java code.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:manageTableAllowed
Type:
xs:boolean, predefined, simple content
Defined:
locally, within dat:TableType complexType
Not currently used.
XML Source (see within schema source)
<xs:element minOccurs="0" name="manageTableAllowed" type="xs:boolean">
<xs:annotation>
<xs:documentation>Not currently used.</xs:documentation>
</xs:annotation>
</xs:element>
dat:manageTables
Type:
xs:string, predefined, simple content
Defined:
locally, within dat:TableType complexType
Not currently used.
XML Source (see within schema source)
<xs:element minOccurs="0" name="manageTables" type="xs:string">
<xs:annotation>
<xs:documentation>Not currently used.</xs:documentation>
</xs:annotation>
</xs:element>
dat:nextStep
Type:
xs:string, predefined, simple content
Defined:
locally, within dat:TableType complexType
Not currently used.
XML Source (see within schema source)
<xs:element minOccurs="0" name="nextStep" type="xs:string">
<xs:annotation>
<xs:documentation>Not currently used.</xs:documentation>
</xs:annotation>
</xs:element>
dat:pkColumnName
Type:
xs:string, predefined, simple content
Defined:
locally, within dat:TableType complexType
A comma-separated ordered list of the column name values that comprise the primary key of the table. Used for list import/export.
XML Source (see within schema source)
<xs:element minOccurs="0" name="pkColumnName" type="xs:string">
<xs:annotation>
<xs:documentation>
A comma-separated ordered list of the column name values that comprise the primary
key of the table. Used for list import/export.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:tableGroup
Type:
xs:string, predefined, simple content
Defined:
locally, within dat:TableType complexType
Not currently used.
XML Source (see within schema source)
<xs:element minOccurs="0" name="tableGroup" type="xs:string">
<xs:annotation>
<xs:documentation>Not currently used.</xs:documentation>
</xs:annotation>
</xs:element>
dat:tableTitle
Type:
xs:string, predefined, simple content
Defined:
locally, within dat:TableType complexType
A preferred title for this table. Used in dataset import/export, and will also be displayed in very limited part of the UI, including the page title of executeQuery
XML Source (see within schema source)
<xs:element minOccurs="0" name="tableTitle" type="xs:string">
<xs:annotation>
<xs:documentation>
A preferred title for this table. Used in dataset import/export, and will also be displayed in very limited part of the UI, including the page title of executeQuery
</xs:documentation>
</xs:annotation>
</xs:element>
dat:tableUrl
Type:
dat:StringExpressionType, simple content
Defined:
locally, within dat:TableType complexType
URL string expression used to render the details link for each row in the table. May be set to a blank value to remove the details column. see ColumnType.url.
XML Source (see within schema source)
<xs:element minOccurs="0" name="tableUrl" type="dat:StringExpressionType">
<xs:annotation>
<xs:documentation>
URL string expression used to render the details link for each row in the table. May be set to
a blank value to remove the details column. see ColumnType.url.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:titleColumn
Type:
xs:string, predefined, simple content
Defined:
locally, within dat:TableType complexType
Specifies the name of the column to display when this table is used as a "lookup table" (i.e., when it is the "references" target of a foreign key relationship). The value of the titleColumn will appear in grid views, details views, and in the drop down controls that appear in insert/update views. The titleColumn is typically used to display a human readable name, label, or description instead of the key value. For example in a table with RowId and Label columns, Label might be set as the titleColumn. Used in list import/export.
XML Source (see within schema source)
<xs:element minOccurs="0" name="titleColumn" type="xs:string">
<xs:annotation>
<xs:documentation>
Specifies the name of the column to display when this table is used as a "lookup table" (i.e., when
it is the "references" target of a foreign key relationship). The value of the titleColumn will
appear in grid views, details views, and in the drop down controls that appear in insert/update
views. The titleColumn is typically used to display a human readable name, label, or description
instead of the key value. For example in a table with RowId and Label columns, Label might be set
as the titleColumn. Used in list import/export.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:updateUrl
Type:
dat:StringExpressionType, simple content
Defined:
locally, within dat:TableType complexType
URL string expression used to render the default update view link for this table. May be set to a blank value to prevent a table's default URL from being used. see ColumnType.url.
XML Source (see within schema source)
<xs:element minOccurs="0" name="updateUrl" type="dat:StringExpressionType">
<xs:annotation>
<xs:documentation>
URL string expression used to render the default update view link for this table. May be set to
a blank value to prevent a table's default URL from being used. see ColumnType.url.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:versionColumnName
Type:
xs:string, predefined, simple content
Defined:
locally, within dat:TableType complexType
The column in the table that acts as a row version stamp for detecting changes to the row. Its value is expected to change when any column within the row is changed. Used for detecting unanticipated changes to a row between the time a user selects a row and the time the same user updates or deletes the row. If the versionColumn detects a change, the user's update or delete fails. If not specified in the table xml, LabKey Server will look for a column named "_ts" which is assumed to be a database-managed row version column, or a column named "Modified", which LabKey Server will update when any row update is made by the LabKey API methods.
XML Source (see within schema source)
<xs:element minOccurs="0" name="versionColumnName" type="xs:string">
<xs:annotation>
<xs:documentation>
The column in the table that acts as a row version stamp for detecting changes to
the row. Its value is expected to change when any column within the row is changed. Used for
detecting unanticipated changes to a row between the time a user selects a row and the time the
same user updates or deletes the row. If the versionColumn detects a change, the user's update
or delete fails. If not specified in the table xml, LabKey Server will look for a column named
"_ts" which is assumed to be a database-managed row version column, or a column named "Modified",
which LabKey Server will update when any row update is made by the LabKey API methods.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:viewOptions
Type:
dat:ViewOptions, complex content
Defined:
locally, within dat:TableType complexType
XML Source (see within schema source)
<xs:element minOccurs="0" name="viewOptions" type="dat:ViewOptions"/>
This XML schema documentation has been generated with DocFlex/XML RE 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set.
DocFlex/XML RE is a reduced edition of DocFlex/XML, which is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually using a high quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML.
DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-end XML Schema documentation generator with simultaneous support of framed multi-file HTML, single-file HTML and RTF output formats. (More formats are planned in the future).
A commercial license for "DocFlex/XML XSDDoc" will allow you:
  • To configure the generated documentation so much as you want. Thanks to our template technology, it was possible to support more than 300 template parameters (working the same as "options" of an ordinary doc-gen), which will give you an unprecedented control over the generated content!
  • To use certain features disabled in the free mode (such as the full documenting of substitution groups).
  • To enable/disable documenting of the initial, imported, included and redefined XML schemas selectively.
  • To document local element components both globally and locally (similar to attributes).
  • To enable/disable reproducing of namespace prefixes.
  • To format your annotations with XHTML tags and reproduce that formatting both in HTML and RTF output.
  • To insert images in your annotations using XHTML <img> tags (supported both in HTML and RTF output).
  • To use PlainDoc.tpl main template to generate all the XML schema documentation in the form of a single HTML file.
  • To use the same template to generate the incredible quality RTF documentation.
  • To document only selected XML schema components specified by name.
  • To remove this very advertisement text
Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML SDK and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required!
But this is not all. In addition to it, a commercial license for DocFlex/XML SDK will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only. And, of course, you could develop any template applications by your own!
Please note: By purchasing a license for this software, you not only acquire a useful tool, you will also make an important investment in its future development, the result of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us!
To buy a license, please follow this link: http://www.filigris.com/shop/