FireDAC.Comp.Client.TFDMetaInfoCommand.ObjectName

From RAD Studio API Documentation
Jump to: navigation, search

[–] Properties
Type: property
Visibility: published
Source:
FireDAC.Comp.Client.pas
FireDAC.Comp.Client.hpp
Unit: FireDAC.Comp.Client
Parent: TFDMetaInfoCommand

Delphi

property ObjectName: String read GetObjectName write SetObjectName;

C++

__property System::UnicodeString ObjectName = {read=GetObjectName, write=SetObjectName};

Description

Gets / Sets the name of the object to get detailed information about.

The ObjectName property value defines the database objects for which detailed information will be returned. The meaning, optionality and usage of catalog and schema names depend on MetaInfoKind:

MetaInfoKind 

Meaning 

Catalog and schema names 

mkTableFields 

Table name. 

Applicable. 

mkIndexes 

Table name. 

Applicable. 

mkIndexFields 

Index name. 

-- 

mkPrimaryKey 

Table name. 

Applicable. 

mkForeignKeys 

Table name. 

Applicable. 

mkForeignKeyFields 

Foreign key constraint name. 

-- 

mkProcArgs 

Stored procedure name. 

Applicable for non-packages stored procedures. 

The ObjectName together with CatalogName and SchemaName may constitute the full object name. If the object name is case sensitive or contains special characters, then it must be explicitly quoted. 

Assigning a value to this property closes the dataset.

Example

var
  oTab: TFDDatSTable;
....
  FDMetaInfoCommand1.CatalogName := 'Northwind';
  FDMetaInfoCommand1.SchemaName := 'dbo';
  FDMetaInfoCommand1.ObjectName := 'Employees';
  FDMetaInfoCommand1.MetaInfoKind := mkTableFields;
  FDMetaInfoCommand1.Define(oTab);
  FDMetaInfoCommand1.Open(oTab);
  FDMetaInfoCommand1.Fetch(oTab, True);

See Also