object-name
The name of the database table or view to expose in the OData metadata.
entityset-name
The name to refer to the exposed table or view defined by the object-name.
included-or-excluded-column-name
When used in conjunction with the with clause, a column name to include in the entity set defined by the entityset-name.
When used in conjunction with the without clause, a column name to exclude in the entity set defined by the entityset-name.
Multiple column names can be referenced.
key-column-name
When used in conjunction with the keys clause, a column name to use as a primary key when one is not specified in the table or view defined the object-name.
When used in conjunction with the generate local clause, a generated key defined as the Edm.Int64 data type. Results are numbered with a starting index of 1.
Generated keys can be used to provide unique IDs in results. They cannot be used for retrieving or dereferencing the entity.
Generated keys are only valid for the duration of the current session. Generated properties cannot be used in $filter or $orderby.
Entity types with generated properties cannot be used in associations.
Multiple keys can be referenced.
association-name
A reference to an association defined in the OSDL file.
Multiple navigation properties can be defined.
navprop-name
The name of a navigation property name.
token-column-name
The names of columns (properties) that are always modified when an Entity instance is modified, such as a DEFAULT
CURRENT TIMESTAMP column or an INTEGER column that is incremented by an update trigger.
The following restrictions apply to the keys clause:
You must specify a key list when referencing a table or view that does not contain a primary key.
You must not specify a key list when referencing a table that contains a primary key.
Primary key properties and properties used as join properties for associations are ignored when included in a property list
associated with the with and without literals. In these instances, the primary key columns are included but the join columns are not unless they are also primary
key columns.
The from clause must be specified if both ends of the association are of the same type.
The concurrencytoken clause is used to generate ETags that identify the state of an entity instance at the time the instance is requested. The
SQL used to generate an ETag uses SHA256 hash functions and can be complex given the types of properties (columns) and number
of properties included in the concurrency token. Concurrency tokens should comprise of a small number of properties, none
of which should be blobs types.
Syntax