Interface IQueryableFieldInfo
Holds the defintion for a field that can be queried using our query tools against a IQueryableItem
This contains information about the field and how to query it
Namespace: LemonEdge.API.Queries
Assembly: API.dll
Syntax
public interface IQueryableFieldInfo
Properties
ColumnName
The actual name of this field in sql. Typically the name of a column in a table or function
Declaration
string ColumnName { get; }
Property Value
Type | Description |
---|---|
System.String |
FieldMapToDescriptorColumnName
The column name this field is a property of in the LemonEdge platform. Used as an optional mapping if this field is actual data from the system.
Not required, but provides useful contextual information for the query tools to know how to join items, display, and/or open them
Declaration
string FieldMapToDescriptorColumnName { get; }
Property Value
Type | Description |
---|---|
System.String |
FieldMapToDescriptorSubTypeID
The unique global id of the sub type (replicated entity descriptor) this field is a property of in the LemonEdge platform. Used as an optional mapping if this field is actual data from the system.
Not required, but provides useful contextual information for the query tools to know how to join items, display, and/or open them
Declaration
Guid? FieldMapToDescriptorSubTypeID { get; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
FieldMapToDescriptorTypeID
The unique global id of the type this field is a property of in the LemonEdge platform. Used as an optional mapping if this field is actual data from the system.
Not required, but provides useful contextual information for the query tools to know how to join items, display, and/or open them
Declaration
Guid? FieldMapToDescriptorTypeID { get; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Guid> |
Name
The name of this field
Declaration
string Name { get; }
Property Value
Type | Description |
---|---|
System.String |
UniqueKey
The unique key for this field within the IQueryableItem.
Declaration
string UniqueKey { get; }
Property Value
Type | Description |
---|---|
System.String |
Methods
FormatStringValueAsSQL(String)
Given a user entered string representing a value for this field, this function translates that to appropriately formatted sql
Declaration
string FormatStringValueAsSQL(string value)
Parameters
Type | Name | Description |
---|---|---|
System.String | value | The string representation of a value for this field |
Returns
Type | Description |
---|---|
System.String | An appropriately formatted sql representation of the specified |
UpdateColumn(String, String, ISQLTypeWrapper)
Given an ISQLTypeWrapper to represent this field in a user created IDataset query, thi functions updates the column
to store all the correct values to represent the schema of this field in sql
Declaration
void UpdateColumn(string queryableItemID, string queryableItemSubID, ISQLTypeWrapper column)
Parameters
Type | Name | Description |
---|---|---|
System.String | queryableItemID | The id of the IQueryableItem this field is a member of within the query |
System.String | queryableItemSubID | |
ISQLTypeWrapper | column | The column for this dataset that should be updated to represent the schema for this field |