TDASchema

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Business rule script from the schema level

property BusinessRulesServer: TDABusinessRuleScript read write

---

Validates the schema properties.

procedure CheckProperties

---

Clears all properties.

procedure Clear

---

Provides access to the collection of all TDASQLCommands defined in the schema.

property Commands: TDASQLCommandCollection read write

---

Sets the TDAConnectionManager component that defines the connection or connections for this schema. When editing the schema in Schema Modeler, the connections will appear in the Connections Pane in the upper right corner.

property ConnectionManager: TDAConnectionManager read write

---

Copies the contents of another schema.

procedure Copy(aSourceSchema: TDAClientSchema; DatasetNames: array of string; CommandNames: array of string; UpdateRuleNames: array of string; RelationShipNames: array of string; UnionDataTablesNames: array of string; JoinDataTablesNames: array of string)

Parameters:

• aSourceSchema: source schema.
• DatasetNames: list of datasets.
• CommandNames: list of commands.
• UpdateRuleNames: list of update rules.
• RelationShipNames: list of relationships.
• UnionDataTablesNames: list of union datatables.
• JoinDataTablesNames: list of join datatables.

---

Copies the contents of another schema.

procedure Copy(aSourceSchema: TDAClientSchema; IncludeDatasets: Boolean; IncludeCommands: Boolean; IncludeUpdateRules: Boolean; IncludeRelationships: Boolean; IncludeUnionDataTables: Boolean; IncludeJoinDataTables: Boolean)

Parameters:

• aSourceSchema: source schema.
• IncludeDatasets: to copy datasets or not
• IncludeCommands: to copy commands or not
• IncludeUpdateRules: to copy update rules or not
• IncludeRelationships: to copy relationships or not
• IncludeUnionDataTables: to copy union datatables or not
• IncludeJoinDataTables: to copy join datatables or not

---

Copies the contents of another schema.

procedure Copy(aSourceSchema: TDASchema; DatasetNames: array of string; CommandNames: array of string; UpdateRuleNames: array of string; RelationShipNames: array of string)

Parameters:

• aSourceSchema: source schema.
• DatasetNames: list of datasets.
• CommandNames: list of commands.
• UpdateRuleNames: list of update rules.
• RelationShipNames: list of relationships.

---

Copies the contents of another schema.

procedure Copy(aSourceSchema: TDASchema; DatasetNames: array of string; CommandNames: array of string; UpdateRuleNames: array of string; RelationShipNames: array of string; UnionDataTablesNames: array of string; JoinDataTablesNames: array of string)

Parameters:

• aSourceSchema: source schema.
• DatasetNames: list of datatables.
• CommandNames: list of commands.
• UpdateRuleNames: list of update rules.
• RelationShipNames: list of relationships.
• UnionDataTablesNames: list of union datatables.
• JoinDataTablesNames: list of join datatables.

---

Copies the contents of another schema.

procedure Copy(aSourceSchema: TDASchema; IncludeDatasets: Boolean; IncludeCommands: Boolean; IncludeUpdateRules: Boolean; IncludeRelationships: Boolean; IncludeUnionDataTables: Boolean; IncludeJoinDataTables: Boolean)

Parameters:

• aSourceSchema: source schema.
• IncludeDatasets: to copy datasets or not
• IncludeCommands: to copy commands or not
• IncludeUpdateRules: to copy update rules or not
• IncludeRelationships: to copy relationships or not
• IncludeUnionDataTables: to copy union datatables or not
• IncludeJoinDataTables: to copy join datatables or not

---

Custom attributes of the schema.

property CustomAttributes: TStrings read write

---

Specifies the TDADataDictionary component used to store the data dictionary for this schema. If this property is unassigned, the Data Dictionary features in Schema Modeler will be disabled.

property DataDictionary: TDADataDictionary read write

---

Holds a collection of all the TDADatasets (a.k.a. Data Tables) defined in the schema.

property Datasets: TDADatasetCollection read write

---

Defines the TDADiagrams component used to store diagrams for this schema. If this property is unassigned, the diagramming features in Schema Modeler will be disabled.

property Diagrams: TDADiagrams read write

---

Tries to find the statement associated with the given connection.

function FindCommandStatement(const aConnection: IDAConnection; aSQLCommand: TDASQLCommand; aStatementName: string; aConnectionType: string): TDAStatement

Parameters:

• aConnection: connection
• aSQLCommand: sql command
• aStatementName: statement name
• aConnectionType: connection type.

---

Finds dataset by name.

function FindDataset(aDatasetName: string): TDADataset

Parameters:

• aDatasetName: given name.

---

Tries to find the statement associated with the given connection.

function FindDatasetStatement(const aConnection: IDAConnection; aDataset: TDADataset; aStatementName: string; aConnectionType: string): TDAStatement

Parameters:

• aConnection: connection
• aDataset: dataset
• aStatementName: statement name
• aConnectionType: connection type.

---

Returns SQL of specified command.

function GetCommandText(const aConnection: IDAConnection; const aName: string): string

Parameters:

• aConnection: connection
• aName: command name

---

Returns actual TDADataset class

function GetDatasetCollectionClass: TDADatasetCollectionClass

---

Returns SQL of specified dataset.

function GetDatasetText(const aConnection: IDAConnection; const aName: string): string

Parameters:

• aConnection: connection
• aName: dataset name

---

Holds a collection of all the TDAJoinDataTables defined in the schema.

property JoinDataTables: TDAJoinDataTableCollection read write

---

procedure LoadFromFile(const aFileName: string)

Parameters:

• aFileName:

---

Restores the component data from file via LoadFromStream.

procedure LoadFromFile(const aFileName: string; aFormat: TDAPersistFormat)

Parameters:

• aFileName: Valid name of the readable file
• aFormat: See TDAPersistFormat

---

procedure LoadFromJson(aJson: ROUTF8String)

Parameters:

• aJson:

---

procedure LoadFromStream(aStream: TStream)

Parameters:

• aStream:

---

Restores the component data stored in the given stream.

procedure LoadFromStream(aStream: TStream; aFormat: TDAPersistFormat)

Parameters:

• aStream: Data storage
• aFormat: See TDAPersistFormat

---

procedure LoadFromString(aValue: ROUTF8String)

Parameters:

• aValue:

---

Uses aXML as storage to load from.

procedure LoadFromXml(aXML: ROUTF8String)

Parameters:

• aXML: Xml text

---

Returns current status. This status is set before saving data to stream and clears after operation.

function MergeDataDictionaries: Boolean

---

property Namespace: string read write

---

Creates a new command

function NewCommand(const aConnection: IDAConnection; const aName: string; aStatementName: string; aConnectionType: string): IDASQLCommand

Parameters:

• aConnection: Specified connection
• aName: Specified command name
• aStatementName: SQL statement that is associated with the new command
• aConnectionType: connection type.

---

Creates a new command

function NewCommand(const aConnection: IDAConnection; const aName: string; const ParamNames: array of string; const ParamValues: array of Variant; ExecuteIt: Boolean; aStatementName: string; aConnectionType: string): IDASQLCommand

Parameters:

• aConnection: Specified connection
• aName: Specified command name
• ParamNames: parameter names
• ParamValues: parameter values
• ExecuteIt: executes created command
• aStatementName: SQL statement that is associated with the new command
• aConnectionType: connection type.

---

function NewDataset(const aConnection: IDAConnection; const aName: string; aDynSelectFields: array of string; aWhereClause: UnicodeString; aStatementName: string; OpenIt: Boolean; AlwaysGenerateDynamicWhereStatement: Boolean; anUnionMapping: TDAColumnMappingCollection; AllowAllFieldsInDynamicWhere: Boolean; aOrderBy: TDAOrderByCollection; aMaxRecords: Integer; aConnectionType: string; aServerSideAccess: Boolean): IDADataset

Parameters:

• aConnection:
• aName:
• aDynSelectFields:
• aWhereClause:
• aStatementName:
• OpenIt:
• AlwaysGenerateDynamicWhereStatement:
• anUnionMapping:
• AllowAllFieldsInDynamicWhere:
• aOrderBy:
• aMaxRecords:
• aConnectionType:
• aServerSideAccess:

---

function NewDataset(const aConnection: IDAConnection; const aName: string; aStatementName: string; OpenIt: Boolean; aConnectionType: string; aServerSideAccess: Boolean): IDADataset

Parameters:

• aConnection:
• aName:
• aStatementName:
• OpenIt:
• aConnectionType:
• aServerSideAccess:

---

function NewDataset(const aConnection: IDAConnection; const aName: string; const ParamNames: array of string; const ParamValues: array of Variant; aDynSelectFields: array of string; aWhereClause: UnicodeString; OpenIt: Boolean; aStatementName: string; AllowAllFieldsInDynamicWhere: Boolean; aOrderBy: TDAOrderByCollection; aMaxRecords: Integer; aConnectionType: string; aServerSideAccess: Boolean): IDADataset

Parameters:

• aConnection:
• aName:
• ParamNames:
• ParamValues:
• aDynSelectFields:
• aWhereClause:
• OpenIt:
• aStatementName:
• AllowAllFieldsInDynamicWhere:
• aOrderBy:
• aMaxRecords:
• aConnectionType:
• aServerSideAccess:

---

function NewDataset(const aConnection: IDAConnection; const aName: string; const ParamNames: array of string; const ParamValues: array of Variant; OpenIt: Boolean; aStatementName: string; aConnectionType: string; aServerSideAccess: Boolean): IDADataset

Parameters:

• aConnection:
• aName:
• ParamNames:
• ParamValues:
• OpenIt:
• aStatementName:
• aConnectionType:
• aServerSideAccess:

---

Creates a new union dataset

function NewUnionDataset(const aConnection: IDAConnection; const aName: string; aDynSelectFields: array of string; aWhereClause: UnicodeString; OpenIt: Boolean; AlwaysGenerateDynamicWhereStatement: Boolean; AllowAllFieldsInDynamicWhere: Boolean): IDADataset

Parameters:

• aConnection: connection
• aName: dataset name.
• aDynSelectFields: fields for Dynamic Select feature.
• aWhereClause: Dynamic Where expression.
• OpenIt: open created dataset.
• AlwaysGenerateDynamicWhereStatement: generate {WHERE} macros.
• AllowAllFieldsInDynamicWhere: Allows to use all fields in Dynamic Where expression.

---

Creates a new union dataset

function NewUnionDataset(const aConnection: IDAConnection; const aName: string; OpenIt: Boolean): IDADataset

Parameters:

• aConnection: connection
• aName: dataset name.
• OpenIt: open created dataset.

---

Creates a new union dataset

function NewUnionDataset(const aConnection: IDAConnection; const aName: string; const ParamNames: array of string; const ParamValues: array of Variant; aDynSelectFields: array of string; aWhereClause: UnicodeString; OpenIt: Boolean; AlwaysGenerateDynamicWhereStatement: Boolean; AllowAllFieldsInDynamicWhere: Boolean; aOrderBy: TDAOrderByCollection): IDADataset

Parameters:

• aConnection: connection
• aName: dataset name.
• ParamNames: parameter names.
• ParamValues: parameter values.
• aDynSelectFields: fields for Dynamic Select feature.
• aWhereClause: Dynamic Where expression.
• OpenIt: open created dataset.
• AlwaysGenerateDynamicWhereStatement: generate {WHERE} macros.
• AllowAllFieldsInDynamicWhere: Allows to use all fields in Dynamic Where expression.
• aOrderBy: collection of OrderBy statements.

---

Creates a new union dataset

function NewUnionDataset(const aConnection: IDAConnection; const aName: string; const ParamNames: array of string; const ParamValues: array of Variant; OpenIt: Boolean): IDADataset

Parameters:

• aConnection: connection
• aName: dataset name.
• ParamNames: parameter names.
• ParamValues: parameter values.
• OpenIt: open created dataset.

---

Creates a new union dataset member.

function NewUnionItemDataset(const aConnection: IDAConnection; const aName: string; const ParamNames: array of string; const ParamValues: array of Variant; aDynSelectFields: array of string; aWhereClause: UnicodeString; anUnionMapping: TDAColumnMappingCollection; AllowAllFieldsInDynamicWhere: Boolean; aOrderBy: TDAOrderByCollection; aMaxRecords: Integer): IDADataset

Parameters:

• aConnection: connection
• aName: dataset name.
• ParamNames: parameter names.
• ParamValues: parameter values.
• aDynSelectFields: fields for Dynamic Select feature.
• aWhereClause: Dynamic Where expression.
• anUnionMapping: column mapping that used by union.
• AllowAllFieldsInDynamicWhere: Allows to use all fields in Dynamic Where expression.
• aOrderBy: collection of OrderBy statements.
• aMaxRecords: Specifies the maximum number of records. A value of -1 (default) will retrieve all records.

---

Forwards notification messages to all owned components.

procedure Notification(aComponent: TComponent; Operation: TOperation)

Parameters:

• aComponent: component
• Operation: operation

---

Allows to change SQL for newly created datasets

property OnGetSQL: TDAOnGetSQLEvent read write
delegate:  procedure OnGetSQL(Sender: TDASchema; const ElementName: string; ElementType: TDASchemaElementType; var SQL: string)

---

Maintains a collection of all the TDADatasetRelationships defined in the schema.

property RelationShips: TDADatasetRelationshipCollection read write

---

Restores specific information not accessible as usual properties.

procedure RestoreNonStreamableProperties(const TempStorage: TPointerArray)

Parameters:

• TempStorage: Array to point to additional values

---

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Stores specific information not accessible as usual properties.

procedure SaveNonStreamableProperties(var TempStorage: TPointerArray)

Parameters:

• TempStorage: Array to point to additional values

---

Stores the component data into file via SaveToStream.

procedure SaveToFile(const aFileName: string; aFormat: TDAPersistFormat)

Parameters:

• aFileName: Valid name of the writable file
• aFormat: See TDAPersistFormat

---

Stores the component data into the given stream.

procedure SaveToStream(aStream: TStream; aFormat: TDAPersistFormat)

Parameters:

• aStream: Data storage
• aFormat: See TDAPersistFormat

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Holds a collection of all the TDAUnionDataTables defined in the schema.

property UnionDataTables: TDAUnionDataTableCollection read write

---

Provides access to the collection of all TDAUpdateRules defined in the schema.

property UpdateRules: TDAUpdateRuleCollection read write

---

Version number of current schema.

property Version: Integer read write

 

Business rule script from the schema level

property BusinessRulesServer: TDABusinessRuleScript read write

---

Provides access to the collection of all TDASQLCommands defined in the schema.

property Commands: TDASQLCommandCollection read write

---

Sets the TDAConnectionManager component that defines the connection or connections for this schema. When editing the schema in Schema Modeler, the connections will appear in the Connections Pane in the upper right corner.

property ConnectionManager: TDAConnectionManager read write

---

Custom attributes of the schema.

property CustomAttributes: TStrings read write

---

Specifies the TDADataDictionary component used to store the data dictionary for this schema. If this property is unassigned, the Data Dictionary features in Schema Modeler will be disabled.

property DataDictionary: TDADataDictionary read write

---

Holds a collection of all the TDADatasets (a.k.a. Data Tables) defined in the schema.

property Datasets: TDADatasetCollection read write

---

Defines the TDADiagrams component used to store diagrams for this schema. If this property is unassigned, the diagramming features in Schema Modeler will be disabled.

property Diagrams: TDADiagrams read write

---

Holds a collection of all the TDAJoinDataTables defined in the schema.

property JoinDataTables: TDAJoinDataTableCollection read write

---

property Namespace: string read write

---

Maintains a collection of all the TDADatasetRelationships defined in the schema.

property RelationShips: TDADatasetRelationshipCollection read write

---

Holds a collection of all the TDAUnionDataTables defined in the schema.

property UnionDataTables: TDAUnionDataTableCollection read write

---

Provides access to the collection of all TDAUpdateRules defined in the schema.

property UpdateRules: TDAUpdateRuleCollection read write

---

Version number of current schema.

property Version: Integer read write

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Validates the schema properties.

procedure CheckProperties

---

Clears all properties.

procedure Clear

---

Copies the contents of another schema.

procedure Copy(aSourceSchema: TDAClientSchema; DatasetNames: array of string; CommandNames: array of string; UpdateRuleNames: array of string; RelationShipNames: array of string; UnionDataTablesNames: array of string; JoinDataTablesNames: array of string)

Parameters:

• aSourceSchema: source schema.
• DatasetNames: list of datasets.
• CommandNames: list of commands.
• UpdateRuleNames: list of update rules.
• RelationShipNames: list of relationships.
• UnionDataTablesNames: list of union datatables.
• JoinDataTablesNames: list of join datatables.

---

Copies the contents of another schema.

procedure Copy(aSourceSchema: TDAClientSchema; IncludeDatasets: Boolean; IncludeCommands: Boolean; IncludeUpdateRules: Boolean; IncludeRelationships: Boolean; IncludeUnionDataTables: Boolean; IncludeJoinDataTables: Boolean)

Parameters:

• aSourceSchema: source schema.
• IncludeDatasets: to copy datasets or not
• IncludeCommands: to copy commands or not
• IncludeUpdateRules: to copy update rules or not
• IncludeRelationships: to copy relationships or not
• IncludeUnionDataTables: to copy union datatables or not
• IncludeJoinDataTables: to copy join datatables or not

---

Copies the contents of another schema.

procedure Copy(aSourceSchema: TDASchema; DatasetNames: array of string; CommandNames: array of string; UpdateRuleNames: array of string; RelationShipNames: array of string)

Parameters:

• aSourceSchema: source schema.
• DatasetNames: list of datasets.
• CommandNames: list of commands.
• UpdateRuleNames: list of update rules.
• RelationShipNames: list of relationships.

---

Copies the contents of another schema.

procedure Copy(aSourceSchema: TDASchema; DatasetNames: array of string; CommandNames: array of string; UpdateRuleNames: array of string; RelationShipNames: array of string; UnionDataTablesNames: array of string; JoinDataTablesNames: array of string)

Parameters:

• aSourceSchema: source schema.
• DatasetNames: list of datatables.
• CommandNames: list of commands.
• UpdateRuleNames: list of update rules.
• RelationShipNames: list of relationships.
• UnionDataTablesNames: list of union datatables.
• JoinDataTablesNames: list of join datatables.

---

Copies the contents of another schema.

procedure Copy(aSourceSchema: TDASchema; IncludeDatasets: Boolean; IncludeCommands: Boolean; IncludeUpdateRules: Boolean; IncludeRelationships: Boolean; IncludeUnionDataTables: Boolean; IncludeJoinDataTables: Boolean)

Parameters:

• aSourceSchema: source schema.
• IncludeDatasets: to copy datasets or not
• IncludeCommands: to copy commands or not
• IncludeUpdateRules: to copy update rules or not
• IncludeRelationships: to copy relationships or not
• IncludeUnionDataTables: to copy union datatables or not
• IncludeJoinDataTables: to copy join datatables or not

---

Tries to find the statement associated with the given connection.

function FindCommandStatement(const aConnection: IDAConnection; aSQLCommand: TDASQLCommand; aStatementName: string; aConnectionType: string): TDAStatement

Parameters:

• aConnection: connection
• aSQLCommand: sql command
• aStatementName: statement name
• aConnectionType: connection type.

---

Finds dataset by name.

function FindDataset(aDatasetName: string): TDADataset

Parameters:

• aDatasetName: given name.

---

Tries to find the statement associated with the given connection.

function FindDatasetStatement(const aConnection: IDAConnection; aDataset: TDADataset; aStatementName: string; aConnectionType: string): TDAStatement

Parameters:

• aConnection: connection
• aDataset: dataset
• aStatementName: statement name
• aConnectionType: connection type.

---

Returns SQL of specified command.

function GetCommandText(const aConnection: IDAConnection; const aName: string): string

Parameters:

• aConnection: connection
• aName: command name

---

Returns actual TDADataset class

function GetDatasetCollectionClass: TDADatasetCollectionClass

---

Returns SQL of specified dataset.

function GetDatasetText(const aConnection: IDAConnection; const aName: string): string

Parameters:

• aConnection: connection
• aName: dataset name

---

procedure LoadFromFile(const aFileName: string)

Parameters:

• aFileName:

---

Restores the component data from file via LoadFromStream.

procedure LoadFromFile(const aFileName: string; aFormat: TDAPersistFormat)

Parameters:

• aFileName: Valid name of the readable file
• aFormat: See TDAPersistFormat

---

procedure LoadFromJson(aJson: ROUTF8String)

Parameters:

• aJson:

---

procedure LoadFromStream(aStream: TStream)

Parameters:

• aStream:

---

Restores the component data stored in the given stream.

procedure LoadFromStream(aStream: TStream; aFormat: TDAPersistFormat)

Parameters:

• aStream: Data storage
• aFormat: See TDAPersistFormat

---

procedure LoadFromString(aValue: ROUTF8String)

Parameters:

• aValue:

---

Uses aXML as storage to load from.

procedure LoadFromXml(aXML: ROUTF8String)

Parameters:

• aXML: Xml text

---

Returns current status. This status is set before saving data to stream and clears after operation.

function MergeDataDictionaries: Boolean

---

Creates a new command

function NewCommand(const aConnection: IDAConnection; const aName: string; aStatementName: string; aConnectionType: string): IDASQLCommand

Parameters:

• aConnection: Specified connection
• aName: Specified command name
• aStatementName: SQL statement that is associated with the new command
• aConnectionType: connection type.

---

Creates a new command

function NewCommand(const aConnection: IDAConnection; const aName: string; const ParamNames: array of string; const ParamValues: array of Variant; ExecuteIt: Boolean; aStatementName: string; aConnectionType: string): IDASQLCommand

Parameters:

• aConnection: Specified connection
• aName: Specified command name
• ParamNames: parameter names
• ParamValues: parameter values
• ExecuteIt: executes created command
• aStatementName: SQL statement that is associated with the new command
• aConnectionType: connection type.

---

function NewDataset(const aConnection: IDAConnection; const aName: string; aDynSelectFields: array of string; aWhereClause: UnicodeString; aStatementName: string; OpenIt: Boolean; AlwaysGenerateDynamicWhereStatement: Boolean; anUnionMapping: TDAColumnMappingCollection; AllowAllFieldsInDynamicWhere: Boolean; aOrderBy: TDAOrderByCollection; aMaxRecords: Integer; aConnectionType: string; aServerSideAccess: Boolean): IDADataset

Parameters:

• aConnection:
• aName:
• aDynSelectFields:
• aWhereClause:
• aStatementName:
• OpenIt:
• AlwaysGenerateDynamicWhereStatement:
• anUnionMapping:
• AllowAllFieldsInDynamicWhere:
• aOrderBy:
• aMaxRecords:
• aConnectionType:
• aServerSideAccess:

---

function NewDataset(const aConnection: IDAConnection; const aName: string; aStatementName: string; OpenIt: Boolean; aConnectionType: string; aServerSideAccess: Boolean): IDADataset

Parameters:

• aConnection:
• aName:
• aStatementName:
• OpenIt:
• aConnectionType:
• aServerSideAccess:

---

function NewDataset(const aConnection: IDAConnection; const aName: string; const ParamNames: array of string; const ParamValues: array of Variant; aDynSelectFields: array of string; aWhereClause: UnicodeString; OpenIt: Boolean; aStatementName: string; AllowAllFieldsInDynamicWhere: Boolean; aOrderBy: TDAOrderByCollection; aMaxRecords: Integer; aConnectionType: string; aServerSideAccess: Boolean): IDADataset

Parameters:

• aConnection:
• aName:
• ParamNames:
• ParamValues:
• aDynSelectFields:
• aWhereClause:
• OpenIt:
• aStatementName:
• AllowAllFieldsInDynamicWhere:
• aOrderBy:
• aMaxRecords:
• aConnectionType:
• aServerSideAccess:

---

function NewDataset(const aConnection: IDAConnection; const aName: string; const ParamNames: array of string; const ParamValues: array of Variant; OpenIt: Boolean; aStatementName: string; aConnectionType: string; aServerSideAccess: Boolean): IDADataset

Parameters:

• aConnection:
• aName:
• ParamNames:
• ParamValues:
• OpenIt:
• aStatementName:
• aConnectionType:
• aServerSideAccess:

---

Creates a new union dataset

function NewUnionDataset(const aConnection: IDAConnection; const aName: string; aDynSelectFields: array of string; aWhereClause: UnicodeString; OpenIt: Boolean; AlwaysGenerateDynamicWhereStatement: Boolean; AllowAllFieldsInDynamicWhere: Boolean): IDADataset

Parameters:

• aConnection: connection
• aName: dataset name.
• aDynSelectFields: fields for Dynamic Select feature.
• aWhereClause: Dynamic Where expression.
• OpenIt: open created dataset.
• AlwaysGenerateDynamicWhereStatement: generate {WHERE} macros.
• AllowAllFieldsInDynamicWhere: Allows to use all fields in Dynamic Where expression.

---

Creates a new union dataset

function NewUnionDataset(const aConnection: IDAConnection; const aName: string; OpenIt: Boolean): IDADataset

Parameters:

• aConnection: connection
• aName: dataset name.
• OpenIt: open created dataset.

---

Creates a new union dataset

function NewUnionDataset(const aConnection: IDAConnection; const aName: string; const ParamNames: array of string; const ParamValues: array of Variant; aDynSelectFields: array of string; aWhereClause: UnicodeString; OpenIt: Boolean; AlwaysGenerateDynamicWhereStatement: Boolean; AllowAllFieldsInDynamicWhere: Boolean; aOrderBy: TDAOrderByCollection): IDADataset

Parameters:

• aConnection: connection
• aName: dataset name.
• ParamNames: parameter names.
• ParamValues: parameter values.
• aDynSelectFields: fields for Dynamic Select feature.
• aWhereClause: Dynamic Where expression.
• OpenIt: open created dataset.
• AlwaysGenerateDynamicWhereStatement: generate {WHERE} macros.
• AllowAllFieldsInDynamicWhere: Allows to use all fields in Dynamic Where expression.
• aOrderBy: collection of OrderBy statements.

---

Creates a new union dataset

function NewUnionDataset(const aConnection: IDAConnection; const aName: string; const ParamNames: array of string; const ParamValues: array of Variant; OpenIt: Boolean): IDADataset

Parameters:

• aConnection: connection
• aName: dataset name.
• ParamNames: parameter names.
• ParamValues: parameter values.
• OpenIt: open created dataset.

---

Creates a new union dataset member.

function NewUnionItemDataset(const aConnection: IDAConnection; const aName: string; const ParamNames: array of string; const ParamValues: array of Variant; aDynSelectFields: array of string; aWhereClause: UnicodeString; anUnionMapping: TDAColumnMappingCollection; AllowAllFieldsInDynamicWhere: Boolean; aOrderBy: TDAOrderByCollection; aMaxRecords: Integer): IDADataset

Parameters:

• aConnection: connection
• aName: dataset name.
• ParamNames: parameter names.
• ParamValues: parameter values.
• aDynSelectFields: fields for Dynamic Select feature.
• aWhereClause: Dynamic Where expression.
• anUnionMapping: column mapping that used by union.
• AllowAllFieldsInDynamicWhere: Allows to use all fields in Dynamic Where expression.
• aOrderBy: collection of OrderBy statements.
• aMaxRecords: Specifies the maximum number of records. A value of -1 (default) will retrieve all records.

---

Forwards notification messages to all owned components.

procedure Notification(aComponent: TComponent; Operation: TOperation)

Parameters:

• aComponent: component
• Operation: operation

---

Restores specific information not accessible as usual properties.

procedure RestoreNonStreamableProperties(const TempStorage: TPointerArray)

Parameters:

• TempStorage: Array to point to additional values

---

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Stores specific information not accessible as usual properties.

procedure SaveNonStreamableProperties(var TempStorage: TPointerArray)

Parameters:

• TempStorage: Array to point to additional values

---

Stores the component data into file via SaveToStream.

procedure SaveToFile(const aFileName: string; aFormat: TDAPersistFormat)

Parameters:

• aFileName: Valid name of the writable file
• aFormat: See TDAPersistFormat

---

Stores the component data into the given stream.

procedure SaveToStream(aStream: TStream; aFormat: TDAPersistFormat)

Parameters:

• aStream: Data storage
• aFormat: See TDAPersistFormat

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

 

Allows to change SQL for newly created datasets

property OnGetSQL: TDAOnGetSQLEvent read write
delegate:  procedure OnGetSQL(Sender: TDASchema; const ElementName: string; ElementType: TDASchemaElementType; var SQL: string)