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.Core.Queryable

Assembly: LemonEdge.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
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
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
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
Guid?

Name

The name of this field

Declaration

string Name { get; }

Property Value

Type	Description
string

UniqueKey

The unique key for this field within the IQueryableItem.

Declaration

string UniqueKey { get; }

Property Value

Type	Description
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
string	value	The string representation of a value for this field

Returns

Type	Description
string	An appropriately formatted sql representation of the specified `value` for this field

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
string	queryableItemID	The id of the IQueryableItem this field is a member of within the query
string	queryableItemSubID
ISQLTypeWrapper	column	The column for this dataset that should be updated to represent the schema for this field