Data types
This page describes the data types available in common and uncommon exposed functions.
Common exposed functions data types
Data types defined below are for common exposed functions.
DataTableFilterCollection
The DataTableFilterCollection is a data structure that contains a list of DataTableFilter objects.
DataTableFilter
A DataTableFilter object represents a collection of filters on a table. Multiple DataTableFilters can be applied in any given select statement. DataTableFilters contain a list of DataTableFilterField objects.
DataTableFilterField
A DataTableFilterField object represents a single filter to be applied to a table. The filter field contains the following members:
| compare | A FieldCompare enumeration. The type of comparison to be made. E.g. “is less than”, “is equal to”. |
| field | The field on which to apply the comparison. |
| filterValue | The value of the comparison. |
The filter [Identifier] < 3 would have the following filter field properties:
| compare | FieldCompare.LessThan |
| field | "Identifier" |
| filterValue | "3" |
SchemaTable
A SchemaTable is a class derived from a DataTable to have a number of predefined columns that make up the information to define a database table schema. The function ‘AddSchemaColumn’ exists to provide a simple method of populating the SchemaTable. A SchemaTable contains the following properties:
| ColumnName | The name used by the Connector for the column. |
| ColumnSize | The maximum size for the length of a column’s value. |
| DataType | The Microsoft .NET framework data type. E.g. a string data type would be typeof(System.String). |
| ProviderType | An indicator of the column’s data type as an OleDb provider type number. |
| AllowDBNull | Whether or not the column allows null values. |
| IsReadOnly | Whether or not the column’s values can be modified. |
| IsKey | Whether the column is a key and therefore used to uniquely identify the row. |
| IsAutoIncrement | Whether the column increments automatically on row creation. |
Uncommon exposed functions data types
Data types defined below are for uncommon exposed functions.PDEFieldValueCollection
This function contains a list of PDEFieldValue objects.
| fieldName | The name of the field to identify. Accepts: string. |
| fieldValue | The field value relating to the fieldName. Accepts: int, string, date&time, float, bool and null. |
