TDASchema

Overview

The TDASchema component represents the complete or partial schema of your database, including the data tables and commands defined for it, as well as relationships between data tables.

While you can edit the contents of a schema from code or in Object Inspector using the Commands, Datasets, Relationships and UpdateRules collection properties, you will usually edit your schema by double-clicking the component to launch Schema Modeler.

Location

Implements

 

constructor Create  override

Creates a new instance.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner.

Assign  override

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

BusinessRulesServer

Business rule script from the schema level

property BusinessRulesServer: TDABusinessRuleScript read write

CheckProperties

Validates the schema properties.

procedure CheckProperties

Clear  override

Clears all properties.

procedure Clear

Commands

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

property Commands:

ConnectionManager

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

Copy (TDAClientSchema, array of string, array of string, array of string, array of string, array of string, array of string)  overload    (declared in TDAClientSchema)

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.

Copy (TDAClientSchema, boolean, boolean, boolean, boolean, boolean, boolean)  overload    (declared in TDAClientSchema)

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

Copy (TDASchema, array of string, array of string, array of string, array of string)  overload deprecated

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.

Copy (TDASchema, array of string, array of string, array of string, array of string, array of string, array of string)  overload

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.

Copy (TDASchema, boolean, boolean, boolean, boolean, boolean, boolean)  overload

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

CustomAttributes

Custom attributes of the schema.

property CustomAttributes:

DataDictionary

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

Datasets

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

property Datasets:

Diagrams

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

FindCommandStatement

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.

FindDataset    (declared in TDAClientSchema)

Finds dataset by name.

function FindDataset(aDatasetName: string): TDADataset

Parameters:

  • aDatasetName: given name.

FindDatasetStatement

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.

GetCommandText  virtual

Returns SQL of specified command.

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

Parameters:

  • aConnection: connection
  • aName: command name

GetDatasetCollectionClass  protected override

Returns actual TDADataset class

function GetDatasetCollectionClass: TDADatasetCollectionClass

GetDatasetText  virtual

Returns SQL of specified dataset.

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

Parameters:

  • aConnection: connection
  • aName: dataset name

JoinDataTables

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

property JoinDataTables:

LoadFromFile    (declared in TDAStreamableComponent)

Restores the component data from file via LoadFromStream.

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

Parameters:


LoadFromStream  virtual    (declared in TDAStreamableComponent)

Restores the component data stored in the given stream.

procedure LoadFromStream(aStream: TStream; aFormat: TDAPersistFormat)

Parameters:


LoadFromXml (ROUTF8String)  overload    (declared in TDAStreamableComponent)

Uses aXML as storage to load from.

procedure LoadFromXml(aXML: ROUTF8String)

Parameters:

  • aXML: Xml text

MergeDataDictionaries  protected

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

function MergeDataDictionaries: Boolean

NewCommand (IDAConnection, string, array of string, array of Variant, boolean, string, string): IDASQLCommand  overload

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.

NewCommand (IDAConnection, string, string, string): IDASQLCommand  overload virtual

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.

NewDataset (IDAConnection, string, array of string, array of Variant, array of string, UnicodeString, boolean, string, Boolean, string, boolean, Integer, string): IDADataset  overload

Creates a new dataset

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; aSortColumnName: string; aSortAscMode: boolean; aMaxRecords: Integer; aConnectionType: string): 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.
  • aStatementName: statement name.
  • AllowAllFieldsInDynamicWhere: Allows to use all fields in Dynamic Where expression.
  • aSortColumnName: sort column name.
  • aSortAscMode: sort direction.
  • aMaxRecords: Specifies the maximum number of records. A value of -1 (default) will retrieve all records.
  • aConnectionType: connection type.

NewDataset (IDAConnection, string, array of string, array of Variant, array of string, UnicodeString, boolean, string, Boolean, TDAOrderByCollection, Integer, string): IDADataset  overload

Creates a new dataset

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): 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.
  • aStatementName: statement name.
  • 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.
  • aConnectionType: connection type.

NewDataset (IDAConnection, string, array of string, array of Variant, boolean, string, string): IDADataset  overload

Creates a new dataset

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

Parameters:

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

NewDataset (IDAConnection, string, array of string, UnicodeString, string, boolean, Boolean, Boolean, string, boolean, Integer, string): IDADataset  overload

Creates a new dataset

function NewDataset(const aConnection: IDAConnection; const aName: string; aDynSelectFields: array of string; aWhereClause: UnicodeString; aStatementName: string; OpenIt: boolean; AlwaysGenerateDynamicWhereStatement: Boolean; AllowAllFieldsInDynamicWhere: Boolean; aSortColumnName: string; aSortAscMode: boolean; aMaxRecords: Integer; aConnectionType: string): IDADataset

Parameters:

  • aConnection: connection
  • aName: dataset name.
  • aDynSelectFields: fields for Dynamic Select feature.
  • aWhereClause: Dynamic Where expression.
  • aStatementName: statement name.
  • OpenIt: open created dataset.
  • AlwaysGenerateDynamicWhereStatement: generate {WHERE} macros.
  • AllowAllFieldsInDynamicWhere: Allows to use all fields in Dynamic Where expression.
  • aSortColumnName: sort column name.
  • aSortAscMode: sort direction.
  • aMaxRecords: Specifies the maximum number of records. A value of -1 (default) will retrieve all records.
  • aConnectionType: connection type.

NewDataset (IDAConnection, string, array of string, UnicodeString, string, boolean, Boolean, TDAColumnMappingCollection, Boolean, TDAOrderByCollection, Integer, string): IDADataset  overload

Creates a new dataset

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): IDADataset

Parameters:

  • aConnection: connection
  • aName: dataset name.
  • aDynSelectFields: fields for Dynamic Select feature.
  • aWhereClause: Dynamic Where expression.
  • aStatementName: statement name.
  • OpenIt: open created dataset.
  • AlwaysGenerateDynamicWhereStatement: generate {WHERE} macros.
  • 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.
  • aConnectionType: connection type.

NewDataset (IDAConnection, string, string, boolean, string): IDADataset  overload virtual

Creates a new dataset

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

Parameters:

  • aConnection: connection
  • aName: dataset name.
  • aStatementName: statement name.
  • OpenIt: open created dataset.
  • aConnectionType: connection type.

NewUnionDataset (IDAConnection, string, array of string, array of Variant, array of string, UnicodeString, boolean, Boolean, Boolean, string, boolean): IDADataset  overload

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; aSortColumnName: string; aSortAscMode: boolean): 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.
  • aSortColumnName: sort column name.
  • aSortAscMode: sort direction.

NewUnionDataset (IDAConnection, string, array of string, array of Variant, array of string, UnicodeString, boolean, Boolean, Boolean, TDAOrderByCollection): IDADataset  overload

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.

NewUnionDataset (IDAConnection, string, array of string, array of Variant, boolean): IDADataset  overload

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.

NewUnionDataset (IDAConnection, string, array of string, UnicodeString, boolean, Boolean, Boolean): IDADataset  overload

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.

NewUnionDataset (IDAConnection, string, boolean): IDADataset  overload

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.

NewUnionItemDataset (IDAConnection, string, array of string, array of Variant, array of string, UnicodeString, TDAColumnMappingCollection, Boolean, string, boolean): IDADataset  overload

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; aSortColumnName: string; aSortAscMode: boolean): 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.
  • aSortColumnName: sort column name.
  • aSortAscMode: sort direction.

NewUnionItemDataset (IDAConnection, string, array of string, array of Variant, array of string, UnicodeString, TDAColumnMappingCollection, Boolean, TDAOrderByCollection, Integer): IDADataset  overload

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.

OnGetSQL

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)

RelationShips

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

property RelationShips:

RestoreNonStreamableProperties  protected override

Restores specific information not accessible as usual properties.

procedure RestoreNonStreamableProperties(const TempStorage: TPointerArray)

Parameters:

  • TempStorage: Array to point to additional values

ROFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned RO components.

procedure ROFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Disables destruction notification for specified RO component.

procedure RORemoveFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

SaveNonStreamableProperties  protected override

Stores specific information not accessible as usual properties.

procedure SaveNonStreamableProperties(var TempStorage: TPointerArray)

Parameters:

  • TempStorage: Array to point to additional values

SaveToFile    (declared in TDAStreamableComponent)

Stores the component data into file via SaveToStream.

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

Parameters:


SaveToStream  override

Stores the component data into the given stream.

procedure SaveToStream(aStream: TStream; aFormat: TDAPersistFormat)

Parameters:


UnionDataTables

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

property UnionDataTables:

UpdateRules

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

property UpdateRules:

Version

Version number of current schema.

property Version:

 

BusinessRulesServer

Business rule script from the schema level

property BusinessRulesServer: TDABusinessRuleScript read write

Commands

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

property Commands:

ConnectionManager

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

CustomAttributes

Custom attributes of the schema.

property CustomAttributes:

DataDictionary

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

Datasets

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

property Datasets:

Diagrams

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

JoinDataTables

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

property JoinDataTables:

RelationShips

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

property RelationShips:

UnionDataTables

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

property UnionDataTables:

UpdateRules

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

property UpdateRules:

Version

Version number of current schema.

property Version:

 

constructor Create  override

Creates a new instance.

constructor Create(aOwner: TComponent)

Parameters:

  • aOwner: Owner.

Assign  override

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

  • Source: Instance whose properties will be copied

CheckProperties

Validates the schema properties.

procedure CheckProperties

Clear  override

Clears all properties.

procedure Clear

Copy (TDAClientSchema, array of string, array of string, array of string, array of string, array of string, array of string)  overload    (declared in TDAClientSchema)

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.

Copy (TDAClientSchema, boolean, boolean, boolean, boolean, boolean, boolean)  overload    (declared in TDAClientSchema)

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

Copy (TDASchema, array of string, array of string, array of string, array of string)  overload deprecated

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.

Copy (TDASchema, array of string, array of string, array of string, array of string, array of string, array of string)  overload

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.

Copy (TDASchema, boolean, boolean, boolean, boolean, boolean, boolean)  overload

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

FindCommandStatement

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.

FindDataset    (declared in TDAClientSchema)

Finds dataset by name.

function FindDataset(aDatasetName: string): TDADataset

Parameters:

  • aDatasetName: given name.

FindDatasetStatement

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.

GetCommandText  virtual

Returns SQL of specified command.

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

Parameters:

  • aConnection: connection
  • aName: command name

GetDatasetCollectionClass  protected override

Returns actual TDADataset class

function GetDatasetCollectionClass: TDADatasetCollectionClass

GetDatasetText  virtual

Returns SQL of specified dataset.

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

Parameters:

  • aConnection: connection
  • aName: dataset name

LoadFromFile    (declared in TDAStreamableComponent)

Restores the component data from file via LoadFromStream.

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

Parameters:


LoadFromStream  virtual    (declared in TDAStreamableComponent)

Restores the component data stored in the given stream.

procedure LoadFromStream(aStream: TStream; aFormat: TDAPersistFormat)

Parameters:


LoadFromXml (ROUTF8String)  overload    (declared in TDAStreamableComponent)

Uses aXML as storage to load from.

procedure LoadFromXml(aXML: ROUTF8String)

Parameters:

  • aXML: Xml text

MergeDataDictionaries  protected

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

function MergeDataDictionaries: Boolean

NewCommand (IDAConnection, string, array of string, array of Variant, boolean, string, string): IDASQLCommand  overload

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.

NewCommand (IDAConnection, string, string, string): IDASQLCommand  overload virtual

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.

NewDataset (IDAConnection, string, array of string, array of Variant, array of string, UnicodeString, boolean, string, Boolean, string, boolean, Integer, string): IDADataset  overload

Creates a new dataset

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; aSortColumnName: string; aSortAscMode: boolean; aMaxRecords: Integer; aConnectionType: string): 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.
  • aStatementName: statement name.
  • AllowAllFieldsInDynamicWhere: Allows to use all fields in Dynamic Where expression.
  • aSortColumnName: sort column name.
  • aSortAscMode: sort direction.
  • aMaxRecords: Specifies the maximum number of records. A value of -1 (default) will retrieve all records.
  • aConnectionType: connection type.

NewDataset (IDAConnection, string, array of string, array of Variant, array of string, UnicodeString, boolean, string, Boolean, TDAOrderByCollection, Integer, string): IDADataset  overload

Creates a new dataset

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): 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.
  • aStatementName: statement name.
  • 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.
  • aConnectionType: connection type.

NewDataset (IDAConnection, string, array of string, array of Variant, boolean, string, string): IDADataset  overload

Creates a new dataset

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

Parameters:

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

NewDataset (IDAConnection, string, array of string, UnicodeString, string, boolean, Boolean, Boolean, string, boolean, Integer, string): IDADataset  overload

Creates a new dataset

function NewDataset(const aConnection: IDAConnection; const aName: string; aDynSelectFields: array of string; aWhereClause: UnicodeString; aStatementName: string; OpenIt: boolean; AlwaysGenerateDynamicWhereStatement: Boolean; AllowAllFieldsInDynamicWhere: Boolean; aSortColumnName: string; aSortAscMode: boolean; aMaxRecords: Integer; aConnectionType: string): IDADataset

Parameters:

  • aConnection: connection
  • aName: dataset name.
  • aDynSelectFields: fields for Dynamic Select feature.
  • aWhereClause: Dynamic Where expression.
  • aStatementName: statement name.
  • OpenIt: open created dataset.
  • AlwaysGenerateDynamicWhereStatement: generate {WHERE} macros.
  • AllowAllFieldsInDynamicWhere: Allows to use all fields in Dynamic Where expression.
  • aSortColumnName: sort column name.
  • aSortAscMode: sort direction.
  • aMaxRecords: Specifies the maximum number of records. A value of -1 (default) will retrieve all records.
  • aConnectionType: connection type.

NewDataset (IDAConnection, string, array of string, UnicodeString, string, boolean, Boolean, TDAColumnMappingCollection, Boolean, TDAOrderByCollection, Integer, string): IDADataset  overload

Creates a new dataset

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): IDADataset

Parameters:

  • aConnection: connection
  • aName: dataset name.
  • aDynSelectFields: fields for Dynamic Select feature.
  • aWhereClause: Dynamic Where expression.
  • aStatementName: statement name.
  • OpenIt: open created dataset.
  • AlwaysGenerateDynamicWhereStatement: generate {WHERE} macros.
  • 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.
  • aConnectionType: connection type.

NewDataset (IDAConnection, string, string, boolean, string): IDADataset  overload virtual

Creates a new dataset

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

Parameters:

  • aConnection: connection
  • aName: dataset name.
  • aStatementName: statement name.
  • OpenIt: open created dataset.
  • aConnectionType: connection type.

NewUnionDataset (IDAConnection, string, array of string, array of Variant, array of string, UnicodeString, boolean, Boolean, Boolean, string, boolean): IDADataset  overload

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; aSortColumnName: string; aSortAscMode: boolean): 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.
  • aSortColumnName: sort column name.
  • aSortAscMode: sort direction.

NewUnionDataset (IDAConnection, string, array of string, array of Variant, array of string, UnicodeString, boolean, Boolean, Boolean, TDAOrderByCollection): IDADataset  overload

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.

NewUnionDataset (IDAConnection, string, array of string, array of Variant, boolean): IDADataset  overload

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.

NewUnionDataset (IDAConnection, string, array of string, UnicodeString, boolean, Boolean, Boolean): IDADataset  overload

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.

NewUnionDataset (IDAConnection, string, boolean): IDADataset  overload

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.

NewUnionItemDataset (IDAConnection, string, array of string, array of Variant, array of string, UnicodeString, TDAColumnMappingCollection, Boolean, string, boolean): IDADataset  overload

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; aSortColumnName: string; aSortAscMode: boolean): 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.
  • aSortColumnName: sort column name.
  • aSortAscMode: sort direction.

NewUnionItemDataset (IDAConnection, string, array of string, array of Variant, array of string, UnicodeString, TDAColumnMappingCollection, Boolean, TDAOrderByCollection, Integer): IDADataset  overload

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.

RestoreNonStreamableProperties  protected override

Restores specific information not accessible as usual properties.

procedure RestoreNonStreamableProperties(const TempStorage: TPointerArray)

Parameters:

  • TempStorage: Array to point to additional values

ROFreeNotification    (declared in TROComponent)

Forwards notification messages to all owned RO components.

procedure ROFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

RORemoveFreeNotification    (declared in TROComponent)

Disables destruction notification for specified RO component.

procedure RORemoveFreeNotification(AComponent: TComponent)

Parameters:

  • AComponent: component

SaveNonStreamableProperties  protected override

Stores specific information not accessible as usual properties.

procedure SaveNonStreamableProperties(var TempStorage: TPointerArray)

Parameters:

  • TempStorage: Array to point to additional values

SaveToFile    (declared in TDAStreamableComponent)

Stores the component data into file via SaveToStream.

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

Parameters:


SaveToStream  override

Stores the component data into the given stream.

procedure SaveToStream(aStream: TStream; aFormat: TDAPersistFormat)

Parameters:

 

OnGetSQL

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)