TableRequestInfoV7

Overview

As well as TableRequestInfo, TableRequestInfoV7 class allows to specify additional custom parameters for getting data from certain schema table.

Location

 

constructor

 

constructor

 

TableRequestInfoV7()

 

Sub New()

AdditionalParameters

It holds all other properties (DASQL, DynamicSelect, OrderBy and %%#WhereClause##)

 

property AdditionalParameters: array of NameValuePair read write;

 

NameValuePair[] AdditionalParameters { get; set; }

 

Property AdditionalParameters() As NameValuePair()

ClearDASQL

 

method ClearDASQL

 

void ClearDASQL()

 

Sub ClearDASQL()

ClearDynamicSelect

Clears DynamicSelect property

 

method ClearDynamicSelect

 

void ClearDynamicSelect()

 

Sub ClearDynamicSelect()

ClearOrderBy

Clears OrderBy property

 

method ClearOrderBy

 

void ClearOrderBy()

 

Sub ClearOrderBy()

ClearWhereClause

Clears WhereClause property

 

method ClearWhereClause

 

void ClearWhereClause()

 

Sub ClearWhereClause()

DASQL

DA SQL value

 

property DASQL: String read write;

 

String DASQL { get; set; }

 

Property DASQL() As String

DynamicSelect

Dynamic Select value

 

property DynamicSelect: String read write;

 

String DynamicSelect { get; set; }

 

Property DynamicSelect() As String

GetAttributeCount    (declared in ComplexType)

 

method GetAttributeCount: Int32

 

Int32 GetAttributeCount()

 

Function GetAttributeCount() As Int32

GetAttributeName    (declared in ComplexType)

 

method GetAttributeName(index: Int32): String

 

String GetAttributeName(Int32 index)

 

Function GetAttributeName(index As Int32) As String

Parameters:

  • index:

GetAttributeValue    (declared in ComplexType)

 

method GetAttributeValue(index: Int32): String

 

String GetAttributeValue(Int32 index)

 

Function GetAttributeValue(index As Int32) As String

Parameters:

  • index:

IncludeSchema    (declared in TableRequestInfo)

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, 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;

 

Boolean IncludeSchema { get; set; }

 

Property IncludeSchema() As Boolean

MaxRecords    (declared in TableRequestInfo)

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: Int32 read write;

 

Int32 MaxRecords { get; set; }

 

Property MaxRecords() As Int32

OrderBy

Dynamic Order value

 

property OrderBy: String read write;

 

String OrderBy { get; set; }

 

Property OrderBy() As String

Parameters    (declared in TableRequestInfo)

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

 

property Parameters: array of DataParameter read write;

 

DataParameter[] Parameters { get; set; }

 

Property Parameters() As DataParameter()

PropertyChanged    (declared in ComplexType)

 

event PropertyChanged: PropertyChangedEventHandler;

 

delegate PropertyChangedEventHandler PropertyChanged()

 

Event PropertyChanged As PropertyChangedEventHandler

ReadComplex

 

method ReadComplex(serializer: Serializer)

 

void ReadComplex(Serializer serializer)

 

Sub ReadComplex(serializer As Serializer)

Parameters:

  • serializer:

TriggerPropertyChanged  protected    (declared in ComplexType)

 

method TriggerPropertyChanged(propertyName: String)

 

void TriggerPropertyChanged(String propertyName)

 

Sub TriggerPropertyChanged(propertyName As String)

Parameters:

  • propertyName:

UserFilter    (declared in TableRequestInfo)

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.

Note: Applying custom filters is not supported by DataAbstract for .NET, you need to use the more advanced feature Dynamic Where there.

 

property UserFilter: String read write;

 

String UserFilter { get; set; }

 

Property UserFilter() As String

WhereClause

Dynamic Where value

 

property WhereClause: String read write;

 

String WhereClause { get; set; }

 

Property WhereClause() As String

WriteComplex

 

method WriteComplex(serializer: Serializer)

 

void WriteComplex(Serializer serializer)

 

Sub WriteComplex(serializer As Serializer)

Parameters:

  • serializer:

 

AdditionalParameters

It holds all other properties (DASQL, DynamicSelect, OrderBy and %%#WhereClause##)

 

property AdditionalParameters: array of NameValuePair read write;

 

NameValuePair[] AdditionalParameters { get; set; }

 

Property AdditionalParameters() As NameValuePair()

DASQL

DA SQL value

 

property DASQL: String read write;

 

String DASQL { get; set; }

 

Property DASQL() As String

DynamicSelect

Dynamic Select value

 

property DynamicSelect: String read write;

 

String DynamicSelect { get; set; }

 

Property DynamicSelect() As String

IncludeSchema    (declared in TableRequestInfo)

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, 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;

 

Boolean IncludeSchema { get; set; }

 

Property IncludeSchema() As Boolean

MaxRecords    (declared in TableRequestInfo)

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: Int32 read write;

 

Int32 MaxRecords { get; set; }

 

Property MaxRecords() As Int32

OrderBy

Dynamic Order value

 

property OrderBy: String read write;

 

String OrderBy { get; set; }

 

Property OrderBy() As String

Parameters    (declared in TableRequestInfo)

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

 

property Parameters: array of DataParameter read write;

 

DataParameter[] Parameters { get; set; }

 

Property Parameters() As DataParameter()

UserFilter    (declared in TableRequestInfo)

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.

Note: Applying custom filters is not supported by DataAbstract for .NET, you need to use the more advanced feature Dynamic Where there.

 

property UserFilter: String read write;

 

String UserFilter { get; set; }

 

Property UserFilter() As String

WhereClause

Dynamic Where value

 

property WhereClause: String read write;

 

String WhereClause { get; set; }

 

Property WhereClause() As String

 

constructor

 

constructor

 

TableRequestInfoV7()

 

Sub New()

ClearDASQL

 

method ClearDASQL

 

void ClearDASQL()

 

Sub ClearDASQL()

ClearDynamicSelect

Clears DynamicSelect property

 

method ClearDynamicSelect

 

void ClearDynamicSelect()

 

Sub ClearDynamicSelect()

ClearOrderBy

Clears OrderBy property

 

method ClearOrderBy

 

void ClearOrderBy()

 

Sub ClearOrderBy()

ClearWhereClause

Clears WhereClause property

 

method ClearWhereClause

 

void ClearWhereClause()

 

Sub ClearWhereClause()

GetAttributeCount    (declared in ComplexType)

 

method GetAttributeCount: Int32

 

Int32 GetAttributeCount()

 

Function GetAttributeCount() As Int32

GetAttributeName    (declared in ComplexType)

 

method GetAttributeName(index: Int32): String

 

String GetAttributeName(Int32 index)

 

Function GetAttributeName(index As Int32) As String

Parameters:

  • index:

GetAttributeValue    (declared in ComplexType)

 

method GetAttributeValue(index: Int32): String

 

String GetAttributeValue(Int32 index)

 

Function GetAttributeValue(index As Int32) As String

Parameters:

  • index:

ReadComplex

 

method ReadComplex(serializer: Serializer)

 

void ReadComplex(Serializer serializer)

 

Sub ReadComplex(serializer As Serializer)

Parameters:

  • serializer:

TriggerPropertyChanged  protected    (declared in ComplexType)

 

method TriggerPropertyChanged(propertyName: String)

 

void TriggerPropertyChanged(String propertyName)

 

Sub TriggerPropertyChanged(propertyName As String)

Parameters:

  • propertyName:

WriteComplex

 

method WriteComplex(serializer: Serializer)

 

void WriteComplex(Serializer serializer)

 

Sub WriteComplex(serializer As Serializer)

Parameters:

  • serializer:

 

PropertyChanged    (declared in ComplexType)

 

event PropertyChanged: PropertyChangedEventHandler;

 

delegate PropertyChangedEventHandler PropertyChanged()

 

Event PropertyChanged As PropertyChangedEventHandler