Data.DB

• Up to Parent: Data

Defines classes and functions that implement datasets, data sources, fields, and so on.

Package	dbrtl370.bpl

Classes

EDatabaseError	EDatabaseError is the exception class for database errors.
EUpdateError	EUpdateError is the exception class for dataset provider update errors.
IBatchDataSet
IDataSetCommandSupport	Interface that extends a TDataSet descendent class to support additional commands.
IDBApplication	Interface for database application.
IDBScreen	Interface to display device.
IDBSession	IDBSession is the interface for database sessions.
IParamObject	IParamObject represents the interface for classes that store a TObject in the variant value of a TParam object.
IParamStreamObject	IParamStreamObject represents the interface for classes that store a TStream in the variant value of a TParam object.
IProviderSupport (deprecated)	IProviderSupport is the interface that datasets use to enable a provider to represent them.
IProviderSupportNG
ISubDataSet	The ISubDataSet is an internal interface used to delegate TField and TDataSet linkage to an intermediate component.
TADTField	A TADTField object represents an ADT (Abstract Data Type) field in a dataset.
TAggHandle	The TAggHandle type represents a data access library object implementing an aggregate field.
TAggregateField	TAggregate field represents a maintained aggregate in a client dataset.
TArrayField	TArrayField represents an Array field in a dataset.
TAutoIncField	TAutoIncField is a persistent field object for an autoincrement field in a dataset.
TBCDField	TBCDField represents a binary-coded decimal (BCD) field in a dataset.
TBinaryField	TBinaryField represents an untyped binary field in a dataset.
TBlobField	TBlobField represents a field in a dataset that holds a reference to a binary large object (BLOB).
TBooleanField	TBooleanField represents a field containing Boolean values.
TByteField	TByteField represents a field that contains a byte value in a dataset.
TBytesField	TBytesField represents a bytes field in a dataset.
TCheckConstraint	TCheckConstraint represents a record-level constraint on a dataset component.
TCheckConstraintClass	Metaclass for the TCheckConstraint class.
TCheckConstraints	TCheckConstraints contains a collection of check constraints for a dataset component.
TCheckConstraintsClass	Metaclass for the TCheckConstraints class.
TCurrencyField	TCurrencyField represents a field that contains currency values in a dataset.
TCustomConnection	TCustomConnection is the base class for components that connect datasets to a remote source of data.
TDataLink	TDataLink is a helper class used by data-aware objects to coordinate the actions of TDataSource and TDataSet, and to respond to data events.
TDataSet	TDataSet is the base class for all dataset components that represent data in rows and columns.
TDataSetClass	TDataSetClass is the class type of a TDataSet descendant.
TDataSetDesigner	TDataSetDesigner is the base class for all dataset designers.
TDataSetField	TDataSetField provides access to nested datasets.
TDataSource	TDataSource provides an interface between a dataset component and data-aware controls on a form.
TDateField	TDateField represents a date field in a dataset.
TDateTimeField	TDateTimeField represents a date-time field in a dataset.
TDBBitConverter	Extends TBitConverter to support database-specific data types.
TDefaultLookupList	TDefaultLookupList is the default implementation of TLookupList.
TDefCollection	TDefCollection holds the definition objects (TNamedItem) that represent the specifications for database entities such as fields or indexes.
TDetailDataLink	TDetailDataLink is the ancestor to datalink classes that manage the relationships between datasets that are linked in master/detail relationships.
TExtendedField	TExtendedField represents a field that contains the highest precision floating point value in a dataset.
TField	TField is the common ancestor of all the field components.
TFieldClass	TFieldClass is the class type of a TField descendant.
TFieldDef	TFieldDef is a field definition that corresponds to a physical field of a record in a table underlying a dataset.
TFieldDefClass	Metaclass for the TFieldDef class.
TFieldDefList	TFieldDefList lists the field definition (TFieldDef) objects of a dataset in a flattened form.
TFieldDefListClass	Metaclass for the TFieldDefList class.
TFieldDefs	TFieldDefs holds the field definition (TFieldDef) objects that represent the physical fields underlying a dataset.
TFieldDefsClass	Metaclass for the TFieldDefs class.
TFieldList	TFieldList lists the fields of a dataset, flattening out the structure of any object fields.
TFieldListClass	Metaclass for the TFieldList class.
TFieldOptions	Represents the options for the fields of a dataset.
TFields	TFields holds the field (TField) objects that represent the physical fields underlying a dataset or an object field such as TADTField and TArrayField.
TFieldsClass	Metaclass for the TFields class.
TFieldsEnumerator	Enumerates database fields.
TFlatList	TFlatList is an abstract base class for objects that represent a flattened list of fields or field definitions.
TFloatField	TFloatField represents a field that contains floating-point values in a dataset.
TFMTBCDField	TFMTBCDField represents a binary-coded decimal (BCD) field in a dataset.
TGraphicField	TGraphicField represents a graphics field in a dataset.
TGuidField	TGuidField represents a guid field in a dataset.
TIDispatchField	TIDispatchField represents an IDispatch field in a dataset.
TIndexDef	TIndexDef describes an index in a database table.
TIndexDefClass	Metaclass for the TIndexDef class.
TIndexDefs	TIndexDefs holds the list of available index definitions for a table.
TIndexDefsClass	Metaclass for the TIndexDefs class.
TIntegerField	Represents a signed 32-bit integer field in a dataset.
TInterfaceField	TInterfaceField represents an interface field in a dataset.
TLargeintField	A TLargeintField object represents a large integer field in a dataset.
TLargeUIntField
TLongWordField	TLongWordField represents a field that contains a positive integer value in a dataset.
TLookupList	TLookupList maintains a list of lookup values associated with a set of key field values.
TLookupListClass	Metaclass for the TLookupList class.
TMasterDataLink	TMasterDataLink allows a dataset to establish a master/detail relationship.
TMemoField	TMemoField represents a memo field in a dataset.
TNamedItem	TNamedItem is the base class for definitions used by datasets.
TNumericField	TNumericField is the common ancestor of all the numeric fields in a dataset.
TObjectField	TObjectField is the common ancestor of TADTField, TArrayField, TDataSetField, and TReferenceField components in a dataset.
TPacketAttributeList	The TPacketAttributeList type represents a list of dataset provider attributes.
TParam	TParam represents a field parameter for a query or stored procedure.
TParamClass	Metaclass for the TParam class.
TParamObject	TParamObject represents the class used to store a TObject in the variant value of a TParam object.
TParamObjectClass	Metaclass for the TParamObject class.
TParams	TParams manages a list of field parameters.
TParamsClass	Metaclass for the TParams class.
TParamStreamObject	TParamStreamObject represents the class used to store a TStream in the variant value of a TParam object.
TPlatformValueBuffer	Cross-platform value buffer.
TReferenceField	TReferenceField represents a REF field in a dataset.
TShortintField	TShortintField represents a field that contains a small integer value in a dataset.
TSingleField	TSingleField represents a field that contains a single precision floating point value in a dataset.
TSmallintField	Represents a signed 16-bit integer field in a dataset.
TSQLTimeStampField	TSQLTimeStampField represents a date-time field in a DBExpress dataset.
TSQLTimeStampOffsetField	TSQLTimeStampOffsetField represents a date-time value with a high degree of accuracy field in a dataset.
TStringField	TStringField represents a string field in a dataset.
TTimeField	TTimeField represents a time field in a dataset.
TUnsignedAutoIncField	TUnsignedAutoIncField is a persistent field object for an auto-increment unsigned integer value field in a dataset.
TVarBytesField	TVarBytesField represents a variable-length untyped binary field in a dataset.
TVariantField	TVariantField represents a variant field in a dataset.
TWideMemoField	TWideMemoField represents a memo field in a dataset.
TWideStringField	TWideStringField represents a large string field in a dataset.
TWordField	Represents an unsigned 16-bit integer field in a dataset.

Routines

BuffersEqual	Indicates whether two buffers have the same contents.
DatabaseError	Creates and raises an EDatabaseError exception.
DatabaseErrorFmt	Creates and raises an EDatabaseError exception with a formatted error message.
DisposeMem	Frees memory.
ExtractFieldName	Returns the next name in a semicolon-delimited string of field names.
GetFieldProperty	Returns a TField object for a dataset and data control.
RegisterFields	Registers a set of field components so that they appear in the Dataset designer.
VarTypeToDataType	Returns the field type value that most closely corresponds to a Variant type.

Types

Data_Db__57
Largeint	Largeint is an alias for Int64.
LargeUint
PBookmarkFlag	PBookmarkFlag is a pointer to TBookmarkFlag.
PDateTimeRec
PLookupListEntry	PLookupListEntry is a pointer to TLookupListEntry.
PPacketAttribute	PPacketAttribute is a pointer to TPacketAttribute.
TAutoRefreshFlag	TAutoRefreshFlag Indicates whether the server provides field values, and if so, why.
TBlobByteData	TBlobByteData stores the contents of a Binary Large Object (BLOB) field.
TBlobData	TBlobData is an alias for TBytes that is used in conjunction with BLOB operations.
TBlobDisplayValue	Defines an enumeration used to control the behavior of TBlobField in the DB-aware controls (such as TDBGrid or TDBEdit).
TBlobStreamMode	TBlobStreamMode indicates how a BLOB stream can be used.
TBlobType	TBlobType indicates the type of a BLOB field.
TBookmark	TBookmark identifies a record in a dataset for later navigation.
TBookmarkFlag	TBookmarkFlag is a set that is used internally.
TBookmarkStr	TBookmarkStr is a bookmark represented as a string.
TBufferList	Represents a list of buffers.
TBufList
TConnectChangeEvent	Type of function called when connection changes.
TDataAction	TDataAction indicates how an application should respond to a database error condition.
TDataChangeEvent	OnDataChange event handler type.
TDataEvent	TDataEvent identifies an event that occurs to a dataset.
TDataOperation	Procedure of object internally used by Data.DB.TDataSet.
TDataSetCommandState
TDataSetCommandStates	Set used to specify the states of a command.
TDataSetErrorEvent	TDataSetErrorEvent is the type of event handler that occurs when TDataSet raises an exception.
TDataSetNotifyEvent	TDataSetNotifyEvent notifies the TDataSet that an event has occurred.
TDataSetState	TDataSetState indicates the current operating mode of a dataset component.
TDateTimeAlias	TDateTimeAlias is an alias for Double.
TDateTimeRec	TDateTimeRec represents a record holding date-time information.
TDBScreenCursor	TDBScreenCursor is a set that specifies the form of the mouse cursor over the screen.
TDefUpdateMethod	Procedure of object used by TDefCollection.UpdateDefs.
TFieldAttribute	TFieldAttribute and TFieldAttributes indicate various attributes of a field.
TFieldAttributes	TFieldAttributes is a set of TFieldAttribute that indicates various field attributes.
TFieldChars	TFieldChars indicates the set of characters that are valid for field.
TFieldGetTextEvent	TFieldGetTextEvent is the type for event handlers that assign a field's value from a string.
TFieldKind	TFieldKind indicates what type of information a field component represents.
TFieldKinds	TFieldKinds is a set of TFieldKind.
TFieldLifeCycle	Indicates the possible field types when the dataset is created.
TFieldLifeCycles	Represents a set of types of fields for the field list.
TFieldNotifyEvent	TFieldNotifyEvent notifies the dataset field that an event has occurred.
TFieldRef	TFieldRef is a pointer to TField.
TFieldsAutoCreationMode	Enumerates the behaviors for creating the automatic fields.
TFieldSetTextEvent	TFieldSetTextEvent is the type for event handlers that assign a field's value from a string.
TFieldsPositionMode	Enumerates the positions of the automatic fields relatively to the existing persistent fields.
TFieldType	TFieldType is a set of values that parallels the data types of fields in tables.
TFieldTypes
TFilterOption	TFilterOption and TFilterOptions influence how filter strings are applied.
TFilterOptions	TFilterOptions is a set of TFilterOption.
TFilterRecordEvent	Event handler that issues an OnFilterRecord event.
TFreeFormDataStreamer
TGetMode	TGetMode is a set that is used to specify the record retrieval mode for the GetRecord method.
TGetResult	TGetResult is a set that is used to specify the results for the GetRecord method.
TGroupPosInd	TGroupPosInd and TGroupPosInds indicate the position of the current record within its group.
TGroupPosInds	TGroupPosInds is a set of TGroupPosInd.
TIndexOption	TIndexOption describes the attributes of an index.
TIndexOptions	TIndexOptions describes the attributes of an index.
TLocateOption	TLocateOption defines the values for the Options parameter of a dataset's Locate method.
TLocateOptions	TLocateOptions defines the values for the Options parameter of the Locate method of a dataset.
TLookupListEntry	TLookupListEntry is a record that holds key-value entries in a lookup list.
TPacketAttribute	TPacketAttribute specifies metadata associated with a DataPacket.
TParamType	TParamType and TParamTypes represent the use of parameters on datasets that represent queries or stored procedures.
TParamTypes	TParamTypes is a set of TParamType.
TProviderFlag	TProviderFlag and TProviderFlags indicate how a provider uses a field value when applying updates.
TProviderFlags	TProviderFlags is a set of TProviderFlag.
TPSCommandType	Enumeration of command types.
TRecBuf	TRecBuf is a NativeInt that allows to access record buffers in a TDataSet.
TRecordBuffer	Represents a pointer to a memory zone used as a buffer.
TResyncMode	TResyncMode is a set of flags that indicate operations a dataset should perform when resynchronizing data.
TResyncModeItem
TSQLCommandType	TSQLCommandType indicates how an SQL dataset specifies the command it executes.
TUpdateAction	TUpdateAction Indicates how a dataset should proceed after an event handler has processed an update.
TUpdateErrorEvent	TUpdateErrorEvent is the event that occurs when errors appear during the update action.
TUpdateKind	TUpdateKind defines the values for the UpdateKind parameter of OnUpdateError and OnUpdateRecord event handlers.
TUpdateMode	TUpdateMode indicates how to locate records so that they can be updated.
TUpdateRecordEvent	TUpdateRecordEvent is the event handler that updates the records of a dataset.
TUpdateRecordType
TUpdateRecordTypes	TUpdateRecordTypes is a set that specifies the update status that is applied to a record.
TUpdateStatus	TUpdateStatus indicates the update status of a record.
TUpdateStatusSet	TUpdateStatusSet is a set of TUpdateStatus.
TValueBuffer

Variables

DBApplication	Variable used to reference DBScreen as IDBApplication.
DBScreen	Variable used to initialize the TDefaultDBScreenApplication class.
DefaultBlobDisplayValue
DefaultCheckConstraintClass	Variable of TCheckConstraintClass type used as result value for TCheckConstraints.GetCheckConstraintClass.
DefaultCheckConstraintsClass	Variable of TCheckConstraintsClass type used as a result value for TDataSet.GetCheckConstraintsClass.
DefaultFieldClasses	Array that holds references to field classes according to field types.
DefaultFieldDefClass	Variable of TFieldDefClass type used as a result value for TFieldDefs.GetFieldDefClass.
DefaultFieldDefListClass	Variable of TFieldDefListClass type used as a result value for TDataSet.GetFieldDefListClass.
DefaultFieldDefsClass	Variable of TFieldDefsClass type used as a result value for TFieldDef.GetChildDefsClass.
DefaultFieldListClass	Variable of TFieldListClass type used as a result value for TDataSet.GetFieldListClass.
DefaultFieldsClass	Variable of TFieldsClass type used as a result value for TDataSet.GetFieldsClass.
DefaultIndexDefClass	Variable of TIndexDefClass type used as a result value for TIndexDefs.GetIndexDefClass.
DefaultIndexDefsClass	Variable of TIndexDefsClass type used as a result value for TDataSet.GetIndexDefsClass.
DefaultLookupListClass	Variable of TLookupListClass type used as a result value for TField.GetLookupListClass.
DefaultParamClass	Variable of TParamClass type used as a result value for TParams.GetParamClass.
DefaultParamsClass	Variable of TParamsClass type used as a result value for GetParamsClass.
FieldTypeNames
FieldTypeVarMap
FreeFormJSONLoader
FreeFormJSONSaver
LoginDialogExProc	Set this variable to specify a method that will provide login information.
LoginDialogProc	Set this variable to specify a method that will provide login information.
PasswordDialog	Displays a dialog box that prompts the user for the password of a local password-protected table.
RegisterFieldsProc	Internally used by the DB design packages.
RemoteLoginDialogProc	Set this variable to specify a method that will provide login information.
ScreenCursorProc	Specifies a method to change the screen cursor.

Constants

dsEditModes	dsEditModes: Set = [dsEdit..dsSetKey];
dsGuidStringLength	dsGuidStringLength: Integer = $26;
dsMaxStringSize	dsMaxStringSize: Integer = $2000;
dsWriteModes	dsWriteModes: Set = [dsEdit..dsNewValue,dsInternalCalc];
fkCalcFieldKinds	fkCalcFieldKinds: Set = [fkCalculated..fkInternalCalc];
ftCalcFieldTypes	ftCalcFieldTypes: Set = [ftString..ftVarBytes,ftFixedChar..ftLargeint,ftGuid..ftFixedWideChar,ftOraTimeStamp..ftExtended,ftTimeStampOffset,ftSingle..ftLargeUint];
ftFixedSizeTypes	ftFixedSizeTypes: Set = [ftSmallint..ftCurrency,ftDate..ftDateTime,ftAutoInc,ftLargeint,ftTimeStamp,ftLongWord..ftExtended,ftTimeStampOffset,ftSingle..ftLargeUint];
ftNonTextTypes	ftNonTextTypes: Set = [ftBytes..ftVarBytes,ftBlob..ftCursor,ftADT..ftDataSet];
ObjectFieldTypes	ObjectFieldTypes: Set = [ftADT..ftDataSet];
sApplyUpdatesDataSetCommand	sApplyUpdatesDataSetCommand: string = ApplyUpdates;
sCancelUpdatesDataSetCommand	sCancelUpdatesDataSetCommand: string = CancelUpdates;