FireDAC.Comp.Client.TFDCustomLocalSQL.Active

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

property Active: Boolean read FActive write SetActive default False;

C++

__property bool Active = {read=FActive, write=SetActive, default=0};

Properties

Type Visibility Source Unit Parent
property public
FireDAC.Comp.Client.pas
FireDAC.Comp.Client.hpp
FireDAC.Comp.Client TFDCustomLocalSQL

Description

Activates the Local SQL engine.

Set the Active property to True to activate the Local SQL engine and to add the registered datasets to the Local SQL namespace. Set Active to False to remove the datasets from the Local SQL namespace and to deactivate the Local SQL engine. Local SQL queries may be performed only when Active is True and the connection is active.

When an application needs to perform massive Local SQL configuration tasks, like adding a set of datasets, removing a set of datasets, and so on, we recommend that you first set Active to False. Then, when a task is finished, set Active to True.

Set Active to False only when there are no active or prepared SQL commands using this Local SQL.

See Also