REST DataWare Documentation v2.0.7

Classe TRESTDWClientSQL

Descrição
Hierarquia
Campos
Métodos
Propriedades

Unit

uRESTDWBasicDB

Declaração

type TRESTDWClientSQL = class(TRESTDWClientSQLBase)

Descrição

No description available, ancestor TRESTDWClientSQLBase description follows
No description available, ancestor TRESTDWMemtable description follows
No description available, ancestor TRESTDWCustomDataSet description follows

Hierarquia

Visão Geral

Campos

Protected vBookmark: Integer;
Protected vActive: Boolean;
Protected vInactive: Boolean;

Métodos

Protected Procedure InternalPost; override;
Protected procedure InternalOpen; override;
Protected Function GetRecordCount: Integer; Override;
Protected procedure InternalRefresh; override;
Protected procedure CloseCursor; override;
Protected Procedure Notification(AComponent: TComponent; Operation: TOperation); override;
Protected Procedure ThreadStart(ExecuteData : TOnExecuteData);
Protected Procedure ThreadDestroy;
Protected Procedure AbortData;
Public Procedure SetInactive(Const Value : Boolean);
Public Procedure Post; Override;
Public Function OpenJson(JsonValue : String = ''; Const ElementRoot : String = ''; Const Utf8SpecialChars : Boolean = False) : Boolean;
Public Procedure SetInBlockEvents(Const Value : Boolean); Override;
Public Procedure SetInitDataset(Const Value : Boolean); Override;
Public Procedure SetInDesignEvents(Const Value : Boolean); Overload;
Public Function GetInBlockEvents: Boolean;
Public Function GetInDesignEvents: Boolean;
Public Procedure NewFieldList;
Public Function GetFieldListByName(aName : String) : TFieldDefinition;
Public Procedure NewDataField(Value : TFieldDefinition);
Public Function FieldListCount: Integer;
Public Procedure Newtable;
Public Procedure PrepareDetailsNew; Override;
Public Procedure PrepareDetails(ActiveMode : Boolean); Override;
Public Procedure FieldDefsToFields;
Public Procedure RebuildMassiveDataset;
Public Class Function FieldDefExist(Const Dataset : TDataset; Value : String) : TFieldDef;
Public Function FieldExist(Value : String) : TField;
Public Procedure Open; Overload;
Public Procedure Open(strSQL : String); Overload; Virtual;
Public Procedure ExecOrOpen;
Public Procedure Close; Virtual;
Public Procedure CreateDataSet;
Public Class Procedure CreateEmptyDataset(Const Dataset : TDataset);
Public Procedure CreateDatasetFromList;
Public Procedure ExecSQL; Overload;
Public Function ExecSQL(Var Error : String) : Boolean; Overload;
Public Function InsertMySQLReturnID: Integer;
Public Function ParamByName(Value : String) : TParam;
Public Procedure ApplyUpdates; Overload; Virtual;
Public Function ApplyUpdates(Var Error : String; ReleaseCache : Boolean = True) : Boolean; Overload;
Public Constructor Create(AOwner : TComponent); Override;
Public Destructor Destroy; Override;
Public Procedure Loaded; Override;
Public procedure OpenCursor(InfoQuery : Boolean); Override;
Public Procedure GotoRec(Const aRecNo : Integer);
Public Function ParamCount: Integer;
Public Procedure DynamicFilter(cFields : Array of String; Value : String; InText : Boolean; AndOrOR : String);
Public Procedure Refresh;
Public Procedure SaveToStream(Var Stream : TMemoryStream);
Public Procedure LoadFromStream(Stream : TMemoryStream);
Public Procedure ClearMassive;
Public Function MassiveCount: Integer;
Public Function MassiveToJSON: String;
Public Procedure DWParams(Var Value : TRESTDWParams);
Public Procedure RestoreDatasetPosition;
Public Procedure SetFilteredB(aValue : Boolean);
Public Procedure InternalLast; Override;
Public Procedure Setnotrepage(Value : Boolean);
Public Procedure SetRecordCount(aJsonCount, aRecordCount : Integer);

Propriedades

Public property RowsAffected : Integer Read vRowsAffected;
Public property ServerFieldList : TFieldsList Read vFieldsList;
Public property Inactive : Boolean Read vInactive Write vInactive;
Public property LastOpen : Integer Read vLastOpen Write vLastOpen;
Public property FieldDefs;
Public property ReadData : Boolean Read GetReadData;
Public property MasterDetailList : TMasterDetailList Read vMasterDetailList Write vMasterDetailList;
Published property MasterDataSet : TRESTDWClientSQL Read vMasterDataSet Write SetMasterDataSet;
Published property DatabaseCharSet;
Published property BinaryCompatibleMode;
Published property MasterCascadeDelete : Boolean Read vCascadeDelete Write vCascadeDelete;
Published property BinaryRequest : Boolean Read vBinaryRequest Write vBinaryRequest;
Published property Datapacks : Integer Read vDatapacks Write SetDatapacks;
Published property OnGetDataError : TOnEventConnection Read vOnGetDataError Write vOnGetDataError;
Published property AfterScroll : TOnAfterScroll Read vOnAfterScroll Write vOnAfterScroll;
Published property AfterOpen : TOnAfterOpen Read vOnAfterOpen Write vOnAfterOpen;
Published property BeforeClose : TOnBeforeClose Read vOnBeforeClose Write vOnBeforeClose;
Published property AfterClose : TOnAfterClose Read vOnAfterClose Write vOnAfterClose;
Published property BeforeRefresh : TOnBeforeRefresh Read vOnBeforeRefresh Write vOnBeforeRefresh;
Published property AfterRefresh : TOnAfterRefresh Read vOnAfterRefresh Write vOnAfterRefresh;
Published property OnFiltered : TOnFiltered Read vOnFiltered Write vOnFiltered;
Published property Active : Boolean Read vActive Write SetActiveDB;
Published property DataCache : Boolean Read vDataCache Write vDataCache;
Published property MassiveType : TMassiveType Read vMassiveMode Write vMassiveMode;
Published property Params : TParams Read vParams Write SetParams;
Published property DataBase : TRESTDWDatabasebaseBase Read vRESTDataBase Write SetDataBase;
Published property ResponseTranslator : TRESTDWResponseTranslator Read GetDWResponseTranslator Write SetDWResponseTranslator;
Published property SQL : TStringList Read vSQL Write SetSQL;
Published property RelationFields : TStringList Read vRelationFields Write vRelationFields;
Published property UpdateTableName : String Read vUpdateTableName Write SetUpdateTableName;
Published property CacheUpdateRecords : Boolean Read vCacheUpdateRecords Write SetCacheUpdateRecords;
Published property AutoCommitData : Boolean Read vAutoCommitData Write vAutoCommitData;
Published property AutoRefreshAfterCommit : Boolean Read vAutoRefreshAfterCommit Write SetAutoRefreshAfterCommit;
Published property ThreadRequest : Boolean Read vPropThreadRequest Write vPropThreadRequest;
Published property RaiseErrors : Boolean Read vRaiseError Write vRaiseError;
Published property BeforeOpen : TDatasetEvents Read vBeforeOpen Write vBeforeOpen;
Published property BeforeEdit : TDatasetEvents Read vBeforeEdit Write vBeforeEdit;
Published property BeforeScroll : TDatasetEvents Read vOnBeforeScroll Write vOnBeforeScroll;
Published property BeforeInsert : TDatasetEvents Read vBeforeInsert Write vBeforeInsert;
Published property BeforePost : TDatasetEvents Read vBeforePost Write vBeforePost;
Published property BeforeDelete : TDatasetEvents Read vBeforeDelete Write vBeforeDelete;
Published property AfterDelete : TDatasetEvents Read vAfterDelete Write vAfterDelete;
Published property AfterEdit : TDatasetEvents Read vAfterEdit Write vAfterEdit;
Published property AfterInsert : TDatasetEvents Read vAfterInsert Write vAfterInsert;
Published property AfterPost : TDatasetEvents Read vAfterPost Write vAfterPost;
Published property AfterCancel : TDatasetEvents Read vAfterCancel Write vAfterCancel;
Published property OnThreadRequestError : TOnThreadRequestError Read vOnThreadRequestError Write vOnThreadRequestError;
Published property UpdateSQL : TRESTDWUpdateSQL Read GetUpdateSQL Write SetUpdateSQL;
Published property OnCalcFields : TDatasetEvents Read vOnCalcFields Write vOnCalcFields;
Published property OnNewRecord : TDatasetEvents Read vNewRecord Write vNewRecord;
Published property MassiveCache : TRESTDWMassiveCache Read GetMassiveCache Write SetMassiveCache;
Published property Filtered : Boolean Read vFiltered Write SetFilteredB;
Published property ReflectChanges : Boolean Read vReflectChanges Write SetReflectChanges;

Descrição

Campos

Protected vBookmark: Integer;

Procedure InternalDeferredPost;override; // Gilberto Rocha 12/04/2019 - usado para poder fazer datasource.dataset.Post

Protected vActive: Boolean;
 
Protected vInactive: Boolean;
 

Métodos

Protected Procedure InternalPost; override;
 
Protected procedure InternalOpen; override;

Gilberto Rocha 12/04/2019 - usado para poder fazer datasource.dataset.Post

Protected Function GetRecordCount: Integer; Override;

Gilberto Rocha 03/09/2021 - usado para poder fazer datasource.dataset.Open

Protected procedure InternalRefresh; override;
 
Protected procedure CloseCursor; override;

Gilberto Rocha 03/09/2021 - usado para poder fazer datasource.dataset.Refresh

Protected Procedure Notification(AComponent: TComponent; Operation: TOperation); override;

Gilberto Rocha 03/09/2021 - usado para poder fazer datasource.dataset.Close

Protected Procedure ThreadStart(ExecuteData : TOnExecuteData);
 
Protected Procedure ThreadDestroy;
 
Protected Procedure AbortData;
 
Public Procedure SetInactive(Const Value : Boolean);

Métodos

Public Procedure Post; Override;
 
Public Function OpenJson(JsonValue : String = ''; Const ElementRoot : String = ''; Const Utf8SpecialChars : Boolean = False) : Boolean;
 
Public Procedure SetInBlockEvents(Const Value : Boolean); Override;
 
Public Procedure SetInitDataset(Const Value : Boolean); Override;
 
Public Procedure SetInDesignEvents(Const Value : Boolean); Overload;
 
Public Function GetInBlockEvents: Boolean;
 
Public Function GetInDesignEvents: Boolean;
 
Public Procedure NewFieldList;
 
Public Function GetFieldListByName(aName : String) : TFieldDefinition;
 
Public Procedure NewDataField(Value : TFieldDefinition);
 
Public Function FieldListCount: Integer;
 
Public Procedure Newtable;
 
Public Procedure PrepareDetailsNew; Override;
 
Public Procedure PrepareDetails(ActiveMode : Boolean); Override;
 
Public Procedure FieldDefsToFields;
 
Public Procedure RebuildMassiveDataset;
 
Public Class Function FieldDefExist(Const Dataset : TDataset; Value : String) : TFieldDef;
 
Public Function FieldExist(Value : String) : TField;
 
Public Procedure Open; Overload;
 
Public Procedure Open(strSQL : String); Overload; Virtual;

Virtual; //Método Open que será utilizado no Componente

Public Procedure ExecOrOpen;

Método Open que será utilizado no Componente

Public Procedure Close; Virtual;

Método Open que será utilizado no Componente

Public Procedure CreateDataSet;

Método Close que será utilizado no Componente

Public Class Procedure CreateEmptyDataset(Const Dataset : TDataset);
 
Public Procedure CreateDatasetFromList;
 
Public Procedure ExecSQL; Overload;
 
Public Function ExecSQL(Var Error : String) : Boolean; Overload;

Método ExecSQL que será utilizado no Componente

Public Function InsertMySQLReturnID: Integer;

Método ExecSQL que será utilizado no Componente

Public Function ParamByName(Value : String) : TParam;

Método de ExecSQL com retorno de Incremento

Public Procedure ApplyUpdates; Overload; Virtual;

Retorna o Parametro de Acordo com seu nome

Public Function ApplyUpdates(Var Error : String; ReleaseCache : Boolean = True) : Boolean; Overload;
 
Public Constructor Create(AOwner : TComponent); Override;

Aplica Alterações no Banco de Dados

Public Destructor Destroy; Override;

Cria o Componente

Public Procedure Loaded; Override;

Destroy a Classe

Public procedure OpenCursor(InfoQuery : Boolean); Override;
 
Public Procedure GotoRec(Const aRecNo : Integer);

Subscrevendo o OpenCursor para não ter erros de ADD Fields em Tempo de Design

Public Function ParamCount: Integer;
 
Public Procedure DynamicFilter(cFields : Array of String; Value : String; InText : Boolean; AndOrOR : String);
 
Public Procedure Refresh;
 
Public Procedure SaveToStream(Var Stream : TMemoryStream);
 
Public Procedure LoadFromStream(Stream : TMemoryStream);
 
Public Procedure ClearMassive;
 
Public Function MassiveCount: Integer;
 
Public Function MassiveToJSON: String;
 
Public Procedure DWParams(Var Value : TRESTDWParams);

Transporte de MASSIVE em formato JSON

Public Procedure RestoreDatasetPosition;
 
Public Procedure SetFilteredB(aValue : Boolean);
 
Public Procedure InternalLast; Override;
 
Public Procedure Setnotrepage(Value : Boolean);
 
Public Procedure SetRecordCount(aJsonCount, aRecordCount : Integer);
 

Propriedades

Public property RowsAffected : Integer Read vRowsAffected;
 
Public property ServerFieldList : TFieldsList Read vFieldsList;
 
Public property Inactive : Boolean Read vInactive Write vInactive;
 
Public property LastOpen : Integer Read vLastOpen Write vLastOpen;
 
Public property FieldDefs;
 
Public property ReadData : Boolean Read GetReadData;
 
Public property MasterDetailList : TMasterDetailList Read vMasterDetailList Write vMasterDetailList;
 
Published property MasterDataSet : TRESTDWClientSQL Read vMasterDataSet Write SetMasterDataSet;
 
Published property DatabaseCharSet;
 
Published property BinaryCompatibleMode;
 
Published property MasterCascadeDelete : Boolean Read vCascadeDelete Write vCascadeDelete;
 
Published property BinaryRequest : Boolean Read vBinaryRequest Write vBinaryRequest;
 
Published property Datapacks : Integer Read vDatapacks Write SetDatapacks;
 
Published property OnGetDataError : TOnEventConnection Read vOnGetDataError Write vOnGetDataError;
 
Published property AfterScroll : TOnAfterScroll Read vOnAfterScroll Write vOnAfterScroll;

Recebe os Erros de ExecSQL ou de GetData

Published property AfterOpen : TOnAfterOpen Read vOnAfterOpen Write vOnAfterOpen;
 
Published property BeforeClose : TOnBeforeClose Read vOnBeforeClose Write vOnBeforeClose;
 
Published property AfterClose : TOnAfterClose Read vOnAfterClose Write vOnAfterClose;
 
Published property BeforeRefresh : TOnBeforeRefresh Read vOnBeforeRefresh Write vOnBeforeRefresh;
 
Published property AfterRefresh : TOnAfterRefresh Read vOnAfterRefresh Write vOnAfterRefresh;
 
Published property OnFiltered : TOnFiltered Read vOnFiltered Write vOnFiltered;
 
Published property Active : Boolean Read vActive Write SetActiveDB;
 
Published property DataCache : Boolean Read vDataCache Write vDataCache;

Estado do Dataset

Published property MassiveType : TMassiveType Read vMassiveMode Write vMassiveMode;

Diz se será salvo o último Stream do Dataset

Published property Params : TParams Read vParams Write SetParams;
 
Published property DataBase : TRESTDWDatabasebaseBase Read vRESTDataBase Write SetDataBase;

Parametros de Dataset

Published property ResponseTranslator : TRESTDWResponseTranslator Read GetDWResponseTranslator Write SetDWResponseTranslator;

Database REST do Dataset

Published property SQL : TStringList Read vSQL Write SetSQL;
 
Published property RelationFields : TStringList Read vRelationFields Write vRelationFields;

SQL a ser Executado

Published property UpdateTableName : String Read vUpdateTableName Write SetUpdateTableName;
 
Published property CacheUpdateRecords : Boolean Read vCacheUpdateRecords Write SetCacheUpdateRecords;

Tabela que será usada para Reflexão de Dados

Published property AutoCommitData : Boolean Read vAutoCommitData Write vAutoCommitData;
 
Published property AutoRefreshAfterCommit : Boolean Read vAutoRefreshAfterCommit Write SetAutoRefreshAfterCommit;
 
Published property ThreadRequest : Boolean Read vPropThreadRequest Write vPropThreadRequest;
 
Published property RaiseErrors : Boolean Read vRaiseError Write vRaiseError;
 
Published property BeforeOpen : TDatasetEvents Read vBeforeOpen Write vBeforeOpen;
 
Published property BeforeEdit : TDatasetEvents Read vBeforeEdit Write vBeforeEdit;
 
Published property BeforeScroll : TDatasetEvents Read vOnBeforeScroll Write vOnBeforeScroll;
 
Published property BeforeInsert : TDatasetEvents Read vBeforeInsert Write vBeforeInsert;
 
Published property BeforePost : TDatasetEvents Read vBeforePost Write vBeforePost;
 
Published property BeforeDelete : TDatasetEvents Read vBeforeDelete Write vBeforeDelete;
 
Published property AfterDelete : TDatasetEvents Read vAfterDelete Write vAfterDelete;
 
Published property AfterEdit : TDatasetEvents Read vAfterEdit Write vAfterEdit;
 
Published property AfterInsert : TDatasetEvents Read vAfterInsert Write vAfterInsert;
 
Published property AfterPost : TDatasetEvents Read vAfterPost Write vAfterPost;
 
Published property AfterCancel : TDatasetEvents Read vAfterCancel Write vAfterCancel;
 
Published property OnThreadRequestError : TOnThreadRequestError Read vOnThreadRequestError Write vOnThreadRequestError;
 
Published property UpdateSQL : TRESTDWUpdateSQL Read GetUpdateSQL Write SetUpdateSQL;
 
Published property OnCalcFields : TDatasetEvents Read vOnCalcFields Write vOnCalcFields;
 
Published property OnNewRecord : TDatasetEvents Read vNewRecord Write vNewRecord;
 
Published property MassiveCache : TRESTDWMassiveCache Read GetMassiveCache Write SetMassiveCache;
 
Published property Filtered : Boolean Read vFiltered Write SetFilteredB;
 
Published property ReflectChanges : Boolean Read vReflectChanges Write SetReflectChanges;

Property ActionCursor : TCursor Read vActionCursor Write vActionCursor;

Gerado por PasDoc 0.16.0.