Table Data Sync for Delphi

Class TOlfTDSDatabase

Description
Hierarchy
Fields
Methods
Properties

Unit

Olf.TableDataSync

Declaration

type TOlfTDSDatabase = class(TComponent)

Description

Attributes
ComponentPlatformsAttribute(pidAllPlatforms)

Hierarchy

Overview

Fields

Protected FTableList: TOlfTDSTableList;

Methods

Protected procedure TableAdd(const Table: TOlfTDSTable);
Protected procedure TableRemove(const Table: TOlfTDSTable);
Protected procedure ProgressAddDoneSteps(const Value: Cardinal);
Protected procedure ProgressRemoveDoneSteps(const Value: Cardinal);
Protected procedure ProgressAddMaxSteps(const Value: Cardinal);
Protected procedure ProgressRemoveMaxSteps(const Value: Cardinal);
Protected function SendRemoteRequest(const EndPoint: string; const Params: TJSONObject): TJSONObject;
Public procedure DoSynchro;
Public procedure Start;
Public procedure Stop(Force: boolean = false);
Public constructor Create(AOwner: TComponent); override;
Public destructor Destroy; override;

Properties

Public property TableList: TOlfTDSTableList read FTableList;
Public property ServerURL: string read getServerURL;
Public property SyncState: TOlfTDSSyncState read FSyncState;
Published property LocalConnectionDefName: string read FLocalConnectionDefName write SetLocalConnectionDefName;
Published property ServerProtocol: TOlfTDSServerProtocol read FServerProtocol write SetServerProtocol;
Published property ServerIPOrDomain: string read FServerIPOrDomain write SetServerIPOrDomain;
Published property ServerPort: Cardinal read FServerPort write SetServerPort;
Published property ServerFolder: string read FServerFolder write SetServerFolder;
Published property SyncMode: TOlfTDSSyncMode read FSyncMode write SetSyncMode;
Published property DefaultChangedFieldName: string read FDefaultChangedFieldName write SetDefaultChangedFieldName;
Published property DefaultChangedDateTimeFieldName: string read FDefaultChangedDateTimeFieldName write SetDefaultChangedDateTimeFieldName;
Published property DefaultNoSeqFieldName: string read FDefaultNoSeqFieldName write SetDefaultNoSeqFieldName;
Published property DeleteTableName: string read FDeleteTableName write SetDeleteTableName;
Published property PrimaryKeyTableName: string read FPrimaryKeyTableName write SetPrimaryKeyTableName;
Published property onSynchroStart: TNotifyEvent read FonSynchroStart write SetonSynchroStart;
Published property onSynchroStop: TNotifyEvent read FonSynchroStop write SetonSynchroStop;
Published property onProgress: TOlfTDSSyncProgressEvent read FonProgress write SetonProgress;
Published property onSessionOpen: TOlfTDSTableSessionOpenEvent read FonSessionOpen write SetonSessionOpen;
Published property onSessionClose: TOlfTDSTableSessionCloseEvent read FonSessionClose write SetonSessionClose;

Description

Fields

Protected FTableList: TOlfTDSTableList;
 

Methods

Protected procedure TableAdd(const Table: TOlfTDSTable);
 
Protected procedure TableRemove(const Table: TOlfTDSTable);
 
Protected procedure ProgressAddDoneSteps(const Value: Cardinal);
 
Protected procedure ProgressRemoveDoneSteps(const Value: Cardinal);
 
Protected procedure ProgressAddMaxSteps(const Value: Cardinal);
 
Protected procedure ProgressRemoveMaxSteps(const Value: Cardinal);
 
Protected function SendRemoteRequest(const EndPoint: string; const Params: TJSONObject): TJSONObject;
 
Public procedure DoSynchro;
 
Public procedure Start;
 
Public procedure Stop(Force: boolean = false);
 
Public constructor Create(AOwner: TComponent); override;
 
Public destructor Destroy; override;
 

Properties

Public property TableList: TOlfTDSTableList read FTableList;
 
Public property ServerURL: string read getServerURL;

********** Propriétés liées au serveur de synchronisation **********

Public property SyncState: TOlfTDSSyncState read FSyncState;

********** Propriétés liées à la synchronisation **********

Published property LocalConnectionDefName: string read FLocalConnectionDefName write SetLocalConnectionDefName;

********** Propriétés liées à la base locale **********

Published property ServerProtocol: TOlfTDSServerProtocol read FServerProtocol write SetServerProtocol;

********** Propriétés liées au serveur de synchronisation **********

Published property ServerIPOrDomain: string read FServerIPOrDomain write SetServerIPOrDomain;
 
Published property ServerPort: Cardinal read FServerPort write SetServerPort;
 
Published property ServerFolder: string read FServerFolder write SetServerFolder;
 
Published property SyncMode: TOlfTDSSyncMode read FSyncMode write SetSyncMode;

********** Propriétés liées à la synchronisation **********

Published property DefaultChangedFieldName: string read FDefaultChangedFieldName write SetDefaultChangedFieldName;

********** Propriétés liées aux champs de synchronisation **********

Published property DefaultChangedDateTimeFieldName: string read FDefaultChangedDateTimeFieldName write SetDefaultChangedDateTimeFieldName;
 
Published property DefaultNoSeqFieldName: string read FDefaultNoSeqFieldName write SetDefaultNoSeqFieldName;
 
Published property DeleteTableName: string read FDeleteTableName write SetDeleteTableName;

Table utilisée pour les suppressions physiques

Utilisée uniquement pour les tables sur lesquelles la suppression logique n'est pas possible.

Published property PrimaryKeyTableName: string read FPrimaryKeyTableName write SetPrimaryKeyTableName;

Table utilisée pour les clés côté serveur

Privilégier le stockage des clés serveur directement dans les tables existantes, mais ça permet de ne pas modifier la structure de la base

Published property onSynchroStart: TNotifyEvent read FonSynchroStart write SetonSynchroStart;

Déclenché au démarrage d'une synchronisation, avant de traiter la liste des tables

Published property onSynchroStop: TNotifyEvent read FonSynchroStop write SetonSynchroStop;

Déclenché en fin de synchronisation, après avoir traité toutes les tables

Published property onProgress: TOlfTDSSyncProgressEvent read FonProgress write SetonProgress;

Déclenché lors de l'ajout ou la suppression d'une étape en cours de synchronisation de la base de données (toutes tables confondues). Permet par exemple de gérer une barre de progression au niveau de l'interface utilisateur.

Published property onSessionOpen: TOlfTDSTableSessionOpenEvent read FonSessionOpen write SetonSessionOpen;

Appelé avant le "login" de synchronisation de chaque table. Permet de paramétrer des informations de connexion comme user/password par ajout de paires clé/valeur au paramètre reçu. Utilisé uniquement si la table en cours de synchronisation n'a pas son propore événement onSessionOpen.

Published property onSessionClose: TOlfTDSTableSessionCloseEvent read FonSessionClose write SetonSessionClose;

Appelé avant le "logout" en fin de synchronisation de chaque table. Utilisé uniquement si la table en cours de synchronisation n'a pas son propore événement onSessionClose.

Table Data Sync for Delphi (c) 2017-2025 Patrick PREMARTIN - Powered by PasDoc
Generated by PasDoc 0.16.0.