element <dat:fk>
Namespace:
http://labkey.org/data/xml
Type:
anonymous complexType
Content:
complex, 8 elements
Defined:
locally within complexType dat:ColumnType in tableInfo.xsd, see XML source
Includes:
definitions of 8 elements
XML Representation Summary
<dat:fk>
   
Content: 
 dat:fkFolderPath? × dat:fkTable × dat:fkColumnName? × dat:fkDbSchema? × dat:fkMultiValued? × dat:fkJunctionLookup? × dat:fkDisplayColumnName? × dat:filters?
</dat:fk>
Content model elements (8):
dat:filters (in dat:fk),
dat:fkColumnName (in dat:fk),
dat:fkDbSchema (in dat:fk),
dat:fkDisplayColumnName (in dat:fk),
dat:fkFolderPath (in dat:fk),
dat:fkJunctionLookup (in dat:fk),
dat:fkMultiValued (in dat:fk),
dat:fkTable (in dat:fk)
Included in content model of elements (1):
dat:column (type dat:ColumnType)
Definition Locations
Annotation
A structure that describes a foreign key relationship between a column in the current table and a target column in another table. Supported for SQL metadata, dataset import/export and list import/export.
XML Source (see within schema source)
<xs:element minOccurs="0" name="fk">
<xs:annotation>
<xs:documentation>
A structure that describes a foreign key relationship between a column in the current table and
a target column in another table.
Supported for SQL metadata, dataset import/export and list import/export.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:all>
<xs:element minOccurs="0" name="fkFolderPath" type="xs:string">
<xs:annotation>
<xs:documentation>
Absolute path to the folder containing the target table of the relationship.
Example: /Home/support/lists.
Supported for SQL metadata, dataset import/export and list import/export.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fkTable" type="xs:string">
<xs:annotation>
<xs:documentation>
The name of the target table of the relationship, the "one" side of the many-to-one
relationship.
Supported for SQL metadata, dataset import/export and list import/export.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="fkColumnName" type="xs:string">
<xs:annotation>
<xs:documentation>
The name of the target column in the target table of the fk relationship. If not
specified, defaults to primary key of the target.
Must be a column that contains 0 or 1 row for any particular value (usually
a primary key or column with a UNIQUE constraint) to prevent row multiplication
when joining.
Supported for SQL metadata.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="fkDbSchema" type="xs:string">
<xs:annotation>
<xs:documentation>
The name of the schema in which the foreign key target is defined. If empty, the
target ("one" side) table is assumed to exist in the same schema as the "many" side
table.
Supported for SQL metadata, dataset import/export and list import/export.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="fkMultiValued" type="xs:string">
<xs:annotation>
<xs:documentation>
Use to specify a multi-valued column. Currently, "junction" is the only legal value.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="fkJunctionLookup" type="xs:string">
<xs:annotation>
<xs:documentation>
Specify the junction lookup column in a many-to-many relationship.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="fkDisplayColumnName" type="dat:FkDisplayColumnNameType">
<xs:annotation>
<xs:documentation>
The name of the column in the lookup's target that should be shown as the value.
If not specified, defaults to the lookup target's title column.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element minOccurs="0" name="filters">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="filterGroup" type="dat:FilterGroupType"/>
</xs:sequence>
</xs:complexType>
</xs:element>
</xs:all>
</xs:complexType>
</xs:element>
Content Element Detail
dat:filters
Type:
anonymous, complex content
Defined:
locally, within (this) dat:fk element
XML Source (see within schema source)
<xs:element minOccurs="0" name="filters">
<xs:complexType>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="filterGroup" type="dat:FilterGroupType"/>
</xs:sequence>
</xs:complexType>
</xs:element>
dat:fkColumnName
Type:
xs:string, predefined, simple content
Defined:
locally, within (this) dat:fk element
The name of the target column in the target table of the fk relationship. If not specified, defaults to primary key of the target. Must be a column that contains 0 or 1 row for any particular value (usually a primary key or column with a UNIQUE constraint) to prevent row multiplication when joining. Supported for SQL metadata.
XML Source (see within schema source)
<xs:element minOccurs="0" name="fkColumnName" type="xs:string">
<xs:annotation>
<xs:documentation>
The name of the target column in the target table of the fk relationship. If not
specified, defaults to primary key of the target.
Must be a column that contains 0 or 1 row for any particular value (usually
a primary key or column with a UNIQUE constraint) to prevent row multiplication
when joining.
Supported for SQL metadata.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:fkDbSchema
Type:
xs:string, predefined, simple content
Defined:
locally, within (this) dat:fk element
The name of the schema in which the foreign key target is defined. If empty, the target ("one" side) table is assumed to exist in the same schema as the "many" side table. Supported for SQL metadata, dataset import/export and list import/export.
XML Source (see within schema source)
<xs:element minOccurs="0" name="fkDbSchema" type="xs:string">
<xs:annotation>
<xs:documentation>
The name of the schema in which the foreign key target is defined. If empty, the
target ("one" side) table is assumed to exist in the same schema as the "many" side
table.
Supported for SQL metadata, dataset import/export and list import/export.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:fkDisplayColumnName
Type:
dat:FkDisplayColumnNameType, simple content
Defined:
locally, within (this) dat:fk element
The name of the column in the lookup's target that should be shown as the value. If not specified, defaults to the lookup target's title column.
XML Source (see within schema source)
<xs:element minOccurs="0" name="fkDisplayColumnName" type="dat:FkDisplayColumnNameType">
<xs:annotation>
<xs:documentation>
The name of the column in the lookup's target that should be shown as the value.
If not specified, defaults to the lookup target's title column.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:fkFolderPath
Type:
xs:string, predefined, simple content
Defined:
locally, within (this) dat:fk element
Absolute path to the folder containing the target table of the relationship. Example: /Home/support/lists. Supported for SQL metadata, dataset import/export and list import/export.
XML Source (see within schema source)
<xs:element minOccurs="0" name="fkFolderPath" type="xs:string">
<xs:annotation>
<xs:documentation>
Absolute path to the folder containing the target table of the relationship.
Example: /Home/support/lists.
Supported for SQL metadata, dataset import/export and list import/export.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:fkJunctionLookup
Type:
xs:string, predefined, simple content
Defined:
locally, within (this) dat:fk element
Specify the junction lookup column in a many-to-many relationship.
XML Source (see within schema source)
<xs:element minOccurs="0" name="fkJunctionLookup" type="xs:string">
<xs:annotation>
<xs:documentation>
Specify the junction lookup column in a many-to-many relationship.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:fkMultiValued
Type:
xs:string, predefined, simple content
Defined:
locally, within (this) dat:fk element
Use to specify a multi-valued column. Currently, "junction" is the only legal value.
XML Source (see within schema source)
<xs:element minOccurs="0" name="fkMultiValued" type="xs:string">
<xs:annotation>
<xs:documentation>
Use to specify a multi-valued column. Currently, "junction" is the only legal value.
</xs:documentation>
</xs:annotation>
</xs:element>
dat:fkTable
Type:
xs:string, predefined, simple content
Defined:
locally, within (this) dat:fk element
The name of the target table of the relationship, the "one" side of the many-to-one relationship. Supported for SQL metadata, dataset import/export and list import/export.
XML Source (see within schema source)
<xs:element name="fkTable" type="xs:string">
<xs:annotation>
<xs:documentation>
The name of the target table of the relationship, the "one" side of the many-to-one
relationship.
Supported for SQL metadata, dataset import/export and list import/export.
</xs:documentation>
</xs:annotation>
</xs:element>
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/