TableRequestInfo

 

Creates a new instance.

constructor Create

---

Creates a new instance with given parameter.

constructor Create(aCollection: TCollection)

Parameters:

• aCollection: collection

---

Copies data from a given source.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Copies the properties of an object to a destination object.

procedure AssignTo(iDest: TPersistent)

Parameters:

• iDest: destination object.

---

Creates and returns a second copy of the struct.

The new instance will be a deep copy of the original struct, all nested members that are arrays, structs or binaries will be duplicated as part of the cloning process, so that the new instance and its members will be completely independent from the original class.

function Clone: TROComplexType

---

property ContentAsJson: UnicodeString read

---

Returns the structure of the type in a string format.

property ContentAsString: string read

---

Returns the XML structure of the type in a string format.

property ContentAsXml: ROUTF8String read

---

property FieldCount: Integer read

---

property FieldInfo[Index: Integer]: PTypeInfo read

---

property FieldName[Index: Integer]: string read

---

procedure FreeInternalProperties

---

Returns the number of custom attributes defined for the class.

class function GetAttributeCount: Integer

---

Returns the name of custom attribute defined for the class, with the specified index.

class function GetAttributeName(aIndex: Integer): string

Parameters:

• aIndex: The index of attribute.

---

Returns the value of custom attribute defined for the class, with the specified index.

class function GetAttributeValue(aIndex: Integer): string

Parameters:

• aIndex: The index of attribute.

---

function GetContentAsJson(aIncludeExtraInfo: Boolean): UnicodeString

Parameters:

• aIncludeExtraInfo:

---

function GetContentAsXml(aOffset: Integer): ROUTF8String

Parameters:

• aOffset:

---

procedure GetFieldNames(aList: TStrings)

Parameters:

• aList:

---

function GetFieldValue(const aFieldName: string): Variant

Parameters:

• aFieldName:

---

Boolean property that specifies if table schema info s needed inside the result stream (true) or not (false, default). Usually, the client side already knows the schema, so passing the schema with the table data will cause some overhead, but if you need to update table schema info on the client side, you need to set that property to true.

For example, in DA for .NET you can create a new DataTable and try to fill it with data from a specified table. Since the structure for the new DataTable is not defined yet, you can establish to put the schema info with the table data, thus giving the data table a proper structure before it will be filled.

property IncludeSchema: Boolean read write

---

This property allows to limit the count of rows of the request. Put it as -1 to receive all available records. 0 value will update the table schema without receiving any data.

Limiting the amount of transferred rows can reduce traffic between the DataAbstract server (middle tier) and the DataAbstract client (front-end tier). It will not affect traffic between the database and the DataAbstract server. For reducing traffic between the database and the DataAbstract server, you have to use other approaches, like Dynamic Where.

property MaxRecords: Integer read write

---

Represents the array of the DataParameters for getting data from parametrized schema tables.

property Parameters: DataParameterArray read write

---

Deserializes current class instance using provided serializer.

procedure ReadComplex(aSerializer: TObject)

Parameters:

• aSerializer: Data source (type TROSerializer).

---

procedure SaveToJson(const aRoot: TROJSONValue; aIncludeExtraInfo: Boolean)

Parameters:

• aRoot:
• aIncludeExtraInfo:

---

procedure SaveToXml(const aNode: TROConverterNode)

Parameters:

• aNode:

---

procedure SetFieldValue(const aFieldName: string; const aValue: Variant)

Parameters:

• aFieldName:
• aValue:

---

Copies specific data from a given source.

procedure SmartAssign(Source: TPersistent; TypeKinds: TTypeKinds)

Parameters:

• Source: Instance whose properties will be copied
• TypeKinds: Specifies which properties should be copied

---

class function TryGetAttribute(aName: string; out aValue: string): Boolean

Parameters:

• aName:
• aValue:

---

Uses for specifying custom conditions for returning rows. For example, "CustomerType < 100". Note that all records will be read from the database, but only those that fit the custom condition will be passed to the client.

property UserFilter: ROUTF8String read write

---

Serializes current class instance using provided serializer.

procedure WriteComplex(aSerializer: TObject)

Parameters:

• aSerializer: Data sink (type TROSerializer)

 

property ContentAsJson: UnicodeString read

---

Returns the structure of the type in a string format.

property ContentAsString: string read

---

Returns the XML structure of the type in a string format.

property ContentAsXml: ROUTF8String read

---

property FieldCount: Integer read

---

property FieldInfo[Index: Integer]: PTypeInfo read

---

property FieldName[Index: Integer]: string read

---

Boolean property that specifies if table schema info s needed inside the result stream (true) or not (false, default). Usually, the client side already knows the schema, so passing the schema with the table data will cause some overhead, but if you need to update table schema info on the client side, you need to set that property to true.

For example, in DA for .NET you can create a new DataTable and try to fill it with data from a specified table. Since the structure for the new DataTable is not defined yet, you can establish to put the schema info with the table data, thus giving the data table a proper structure before it will be filled.

property IncludeSchema: Boolean read write

---

This property allows to limit the count of rows of the request. Put it as -1 to receive all available records. 0 value will update the table schema without receiving any data.

Limiting the amount of transferred rows can reduce traffic between the DataAbstract server (middle tier) and the DataAbstract client (front-end tier). It will not affect traffic between the database and the DataAbstract server. For reducing traffic between the database and the DataAbstract server, you have to use other approaches, like Dynamic Where.

property MaxRecords: Integer read write

---

Represents the array of the DataParameters for getting data from parametrized schema tables.

property Parameters: DataParameterArray read write

---

Uses for specifying custom conditions for returning rows. For example, "CustomerType < 100". Note that all records will be read from the database, but only those that fit the custom condition will be passed to the client.

property UserFilter: ROUTF8String read write

 

Returns the number of custom attributes defined for the class.

class function GetAttributeCount: Integer

---

Returns the name of custom attribute defined for the class, with the specified index.

class function GetAttributeName(aIndex: Integer): string

Parameters:

• aIndex: The index of attribute.

---

Returns the value of custom attribute defined for the class, with the specified index.

class function GetAttributeValue(aIndex: Integer): string

Parameters:

• aIndex: The index of attribute.

---

class function TryGetAttribute(aName: string; out aValue: string): Boolean

Parameters:

• aName:
• aValue:

 

Creates a new instance.

constructor Create

---

Creates a new instance with given parameter.

constructor Create(aCollection: TCollection)

Parameters:

• aCollection: collection

---

Copies data from a given source.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Copies the properties of an object to a destination object.

procedure AssignTo(iDest: TPersistent)

Parameters:

• iDest: destination object.

---

Creates and returns a second copy of the struct.

The new instance will be a deep copy of the original struct, all nested members that are arrays, structs or binaries will be duplicated as part of the cloning process, so that the new instance and its members will be completely independent from the original class.

function Clone: TROComplexType

---

procedure FreeInternalProperties

---

function GetContentAsJson(aIncludeExtraInfo: Boolean): UnicodeString

Parameters:

• aIncludeExtraInfo:

---

function GetContentAsXml(aOffset: Integer): ROUTF8String

Parameters:

• aOffset:

---

procedure GetFieldNames(aList: TStrings)

Parameters:

• aList:

---

function GetFieldValue(const aFieldName: string): Variant

Parameters:

• aFieldName:

---

Deserializes current class instance using provided serializer.

procedure ReadComplex(aSerializer: TObject)

Parameters:

• aSerializer: Data source (type TROSerializer).

---

procedure SaveToJson(const aRoot: TROJSONValue; aIncludeExtraInfo: Boolean)

Parameters:

• aRoot:
• aIncludeExtraInfo:

---

procedure SaveToXml(const aNode: TROConverterNode)

Parameters:

• aNode:

---

procedure SetFieldValue(const aFieldName: string; const aValue: Variant)

Parameters:

• aFieldName:
• aValue:

---

Copies specific data from a given source.

procedure SmartAssign(Source: TPersistent; TypeKinds: TTypeKinds)

Parameters:

• Source: Instance whose properties will be copied
• TypeKinds: Specifies which properties should be copied

---

Serializes current class instance using provided serializer.

procedure WriteComplex(aSerializer: TObject)

Parameters:

• aSerializer: Data sink (type TROSerializer)