TableRequestInfo
Overview
TableRequestInfo allows you to specify additional parameters for querying certain schema tables.
With TableRequestInfo you can:
- specify custom parameters for getting data from parametrized schema tables.
- specify if schema information is received inside the encoded schema table data.
- specify the count of records you want to obtain.
Instances of the TableRequestInfo class are usually created on the client side and then passed into certain overloads of the DataAdapter.Fill method. Further TableRequestInfo will be serialized into GetData request that will be sent to the server.
Location
- Reference: DataAbstract4_Intf.h
- Namespace: DataAbstract
- Ancestry: NSObject | ROComplexType | TableRequestInfo
assignFrom: assignFrom:(ROComplexType *)
Configures instance of the TableRequestInfo class according to given source
- (void) assignFrom:(ROComplexType *)aValue
Parameters:
- aValue:
assignFrom: assignFrom:(nonnull ROComplexType *) (declared in ROComplexType)
- (void) assignFrom:(nonnull ROComplexType *)source
Parameters:
- source:
deepCopyWithZone: deprecated (declared in ROComplexType)
- (nullable id) deepCopyWithZone:(nullable NSZone *)zone
Parameters:
- zone:
getAttributeValue: (declared in ROComplexType)
+ (nullable NSString *) getAttributeValue:(nonnull NSString *)aName
Parameters:
- aName:
IncludeSchema nonatomic
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.
@property (nonatomic) BOOL IncludeSchema
MaxRecords nonatomic
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 (nonatomic) int32 MaxRecords
Parameters nonatomic
Represents the array of the DataParameters for getting data from parametrized schema tables.
@property (nonatomic) DataParameterArray *Parameters
readFromMessage:withName: readFromMessage:(nonnull ROMessage *) withName:(nullable NSString *) (declared in ROComplexType)
- (void) readFromMessage:(nonnull ROMessage *)aMessage withName:(nullable NSString *)aName
Parameters:
- aMessage:
- aName:
readFromMessage:withName: readFromMessage:(ROMessage *) withName:(NSString *)
Metod deserializes TableRequestInfo with given name from given message
- (void) readFromMessage:(ROMessage *)aMessage withName:(NSString *)aName
Parameters:
- aMessage:
- aName:
UserFilter nonatomic
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 (nonatomic) NSString *UserFilter
writeToMessage:withName: writeToMessage:(nonnull ROMessage *) withName:(nullable NSString *) (declared in ROComplexType)
- (void) writeToMessage:(nonnull ROMessage *)aMessage withName:(nullable NSString *)aName
Parameters:
- aMessage:
- aName:
writeToMessage:withName: writeToMessage:(ROMessage *) withName:(NSString *)
Metod serializes TableRequestInfo with given name into given message.
- (void) writeToMessage:(ROMessage *)aMessage withName:(NSString *)aName
Parameters:
- aMessage:
- aName:
IncludeSchema nonatomic
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.
@property (nonatomic) BOOL IncludeSchema
MaxRecords nonatomic
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 (nonatomic) int32 MaxRecords
Parameters nonatomic
Represents the array of the DataParameters for getting data from parametrized schema tables.
@property (nonatomic) DataParameterArray *Parameters
UserFilter nonatomic
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 (nonatomic) NSString *UserFilter
getAttributeValue: (declared in ROComplexType)
+ (nullable NSString *) getAttributeValue:(nonnull NSString *)aName
Parameters:
- aName:
assignFrom: assignFrom:(ROComplexType *)
Configures instance of the TableRequestInfo class according to given source
- (void) assignFrom:(ROComplexType *)aValue
Parameters:
- aValue:
assignFrom: assignFrom:(nonnull ROComplexType *) (declared in ROComplexType)
- (void) assignFrom:(nonnull ROComplexType *)source
Parameters:
- source:
deepCopyWithZone: deprecated (declared in ROComplexType)
- (nullable id) deepCopyWithZone:(nullable NSZone *)zone
Parameters:
- zone:
readFromMessage:withName: readFromMessage:(nonnull ROMessage *) withName:(nullable NSString *) (declared in ROComplexType)
- (void) readFromMessage:(nonnull ROMessage *)aMessage withName:(nullable NSString *)aName
Parameters:
- aMessage:
- aName:
readFromMessage:withName: readFromMessage:(ROMessage *) withName:(NSString *)
Metod deserializes TableRequestInfo with given name from given message
- (void) readFromMessage:(ROMessage *)aMessage withName:(NSString *)aName
Parameters:
- aMessage:
- aName:
writeToMessage:withName: writeToMessage:(nonnull ROMessage *) withName:(nullable NSString *) (declared in ROComplexType)
- (void) writeToMessage:(nonnull ROMessage *)aMessage withName:(nullable NSString *)aName
Parameters:
- aMessage:
- aName:
writeToMessage:withName: writeToMessage:(ROMessage *) withName:(NSString *)
Metod serializes TableRequestInfo with given name into given message.
- (void) writeToMessage:(ROMessage *)aMessage withName:(NSString *)aName
Parameters:
- aMessage:
- aName: