FireDAC.Comp.Client.TFDMetaInfoQuery.BaseObjectName

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property BaseObjectName: String read GetBaseObjectName write SetBaseObjectName;

C++

__property System::UnicodeString BaseObjectName = {read=GetBaseObjectName, write=SetBaseObjectName};

Properties

Type Visibility Source Unit Parent
property published
FireDAC.Comp.Client.pas
FireDAC.Comp.Client.hpp
FireDAC.Comp.Client TFDMetaInfoQuery

Description

Gets / Sets the name of the base object.

The BaseObjectName property value meaning and optionality depend on MetaInfoKind:

MetaInfoKind 

Meaning 

mkIndexFields 

Table name. 

mkPrimaryKeyFields 

Table name. 

mkForeignKeyFields 

Table name. 

mkProcs 

Package name. 

mkProcArgs 

Package name. 

The BaseObjectName property value together with CatalogName and SchemaName constitute the full base object name. If the current DBMS session "sees" several objects with the same name, but in different catalogs and/or schema, then we strongly suggest to specify CatalogName and/or SchemaName property values to explicitly limit the list of objects. 

If BaseObjectName is case sensitive or contains special characters, then it must be explicitly quoted. 

Assigning a value to this property closes the dataset.

Example

  // SQL Server: retrieve foreign key fields for FK_DEPARTMENTS constraint of the Northwind.dbo.Employees table
  FDMetaInfoQuery1.BaseObjectName := 'Northwind.dbo.Employees';
  FDMetaInfoQuery1.ObjectName := 'FK_DEPARTMENTS';
  FDMetaInfoQuery1.MetaInfoKind := mkForeignKeyFields;
  FDMetaInfoQuery1.Open;

  // Oracle: retrieve procedure list for the SYS.DBMS_SQL package
  FDMetaInfoQuery1.BaseObjectName := 'SYS.DBMS_SQL';

  FDMetaInfoQuery1.MetaInfoKind := mkProcs;
  FDMetaInfoQuery1.Open;

See Also