Data.DB

From RAD Studio API Documentation
Jump to: navigation, search

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

Package dbrtl.bpl

Classes

EDatabaseErrorEDatabaseError is the exception class for database errors.
EUpdateErrorEUpdateError is the exception class for dataset provider update errors.
IDataSetCommandSupportInterface that extends a TDataSet descendent class to support additional commands.
IDBApplicationInterface for database application.
IDBScreenInterface to display device.
IDBSessionIDBSession is the interface for database sessions.
IParamObjectIParamObject represents the interface for classes that store a TObject in the variant value of a TParam object.
IParamStreamObjectIParamStreamObject 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
TADTFieldA TADTField object represents an ADT (Abstract Data Type) field in a dataset.
TAggHandle
TAggregateFieldTAggregate field represents a maintained aggregate in a client dataset.
TArrayFieldTArrayField represents an Array field in a dataset.
TAutoIncFieldTAutoIncField is a persistent field object for an autoincrement field in a dataset.
TBCDFieldTBCDField represents a binary-coded decimal (BCD) field in a dataset.
TBinaryFieldTBinaryField represents an untyped binary field in a dataset.
TBlobFieldTBlobField represents a field in a dataset that holds a reference to a binary large object (BLOB).
TBooleanFieldTBooleanField represents a field containing Boolean values.
TByteFieldTByteField represents a field that contains a byte value in a dataset.
TBytesFieldTBytesField represents a bytes field in a dataset.
TCheckConstraintTCheckConstraint represents a record-level constraint on a dataset component.
TCheckConstraintClassMetaclass for the TCheckConstraint class.
TCheckConstraintsTCheckConstraints contains a collection of check constraints for a dataset component.
TCheckConstraintsClassMetaclass for the TCheckConstraints class.
TCurrencyFieldTCurrencyField represents a field that contains currency values in a dataset.
TCustomConnectionTCustomConnection is the base class for components that connect datasets to a remote source of data.
TDataLinkTDataLink is a helper class used by data-aware objects to coordinate the actions of TDataSource and TDataSet, and to respond to data events.
TDataSetTDataSet is the base class for all dataset components that represent data in rows and columns.
TDataSetClassTDataSetClass is the class type of a TDataSet descendant.
TDataSetDesignerTDataSetDesigner is the base class for all dataset designers.
TDataSetFieldTDataSetField provides access to nested datasets.
TDataSourceTDataSource provides an interface between a dataset component and data-aware controls on a form.
TDateFieldTDateField represents a date field in a dataset.
TDateTimeFieldTDateTimeField represents a date-time field in a dataset.
TDBBitConverterExtends TBitConverter to support database-specific data types.
TDefaultLookupListTDefaultLookupList is the default implementation of TLookupList.
TDefCollectionTDefCollection holds the definition objects (TNamedItem) that represent the specifications for database entities such as fields or indexes.
TDetailDataLinkTDetailDataLink is the ancestor to datalink classes that manage the relationships between datasets that are linked in master/detail relationships.
TExtendedFieldTExtendedField represents a field that contains the highest precision floating point value in a dataset.
TFieldTField is the common ancestor of all the field components.
TFieldClassTFieldClass is the class type of a TField descendant.
TFieldDefTFieldDef is a field definition that corresponds to a physical field of a record in a table underlying a dataset.
TFieldDefClassMetaclass for the TFieldDef class.
TFieldDefListTFieldDefList lists the field definition (TFieldDef) objects of a dataset in a flattened form.
TFieldDefListClassMetaclass for the TFieldDefList class.
TFieldDefsTFieldDefs holds the field definition (TFieldDef) objects that represent the physical fields underlying a dataset.
TFieldDefsClassMetaclass for the TFieldDefs class.
TFieldListTFieldList lists the fields of a dataset, flattening out the structure of any object fields.
TFieldListClassMetaclass for the TFieldList class.
TFieldOptionsRepresents the options for the fields of a dataset.
TFieldsTFields holds the field (TField) objects that represent the physical fields underlying a dataset or an object field such as TADTField and TArrayField.
TFieldsClassMetaclass for the TFields class.
TFieldsEnumeratorEnumerates database fields.
TFlatListTFlatList is an abstract base class for objects that represent a flattened list of fields or field definitions.
TFloatFieldTFloatField represents a field that contains floating-point values in a dataset.
TFMTBCDFieldTFMTBCDField represents a binary-coded decimal (BCD) field in a dataset.
TGraphicFieldTGraphicField represents a graphics field in a dataset.
TGuidFieldTGuidField represents a guid field in a dataset.
TIDispatchFieldTIDispatchField represents an IDispatch field in a dataset.
TIndexDefTIndexDef describes an index in a database table.
TIndexDefClassMetaclass for the TIndexDef class.
TIndexDefsTIndexDefs holds the list of available index definitions for a table.
TIndexDefsClassMetaclass for the TIndexDefs class.
TIntegerFieldRepresents a signed 32-bit integer field in a dataset.
TInterfaceFieldTInterfaceField represents an interface field in a dataset.
TLargeintFieldA TLargeintField object represents a large integer field in a dataset.
TLongWordFieldTLongWordField represents a field that contains a positive integer value in a dataset.
TLookupListTLookupList maintains a list of lookup values associated with a set of key field values.
TLookupListClassMetaclass for the TLookupList class.
TMasterDataLinkTMasterDataLink allows a dataset to establish a master/detail relationship.
TMemoFieldTMemoField represents a memo field in a dataset.
TNamedItemTNamedItem is the base class for definitions used by datasets.
TNumericFieldTNumericField is the common ancestor of all the numeric fields in a dataset.
TObjectFieldTObjectField is the common ancestor of TADTField, TArrayField, TDataSetField, and TReferenceField components in a dataset.
TPacketAttributeList
TParamTParam represents a field parameter for a query or stored procedure.
TParamClassMetaclass for the TParam class.
TParamObjectTParamObject represents the class used to store a TObject in the variant value of a TParam object.
TParamObjectClassMetaclass for the TParamObject class.
TParamsTParams manages a list of field parameters.
TParamsClassMetaclass for the TParams class.
TParamStreamObjectTParamStreamObject represents the class used to store a TStream in the variant value of a TParam object.
TPlatformValueBufferCross-platform value buffer.
TReferenceFieldTReferenceField represents a REF field in a dataset.
TShortintFieldTShortintField represents a field that contains a small integer value in a dataset.
TSingleFieldTSingleField represents a field that contains a single precision floating point value in a dataset.
TSmallintFieldRepresents a signed 16-bit integer field in a dataset.
TSQLTimeStampFieldTSQLTimeStampField represents a date-time field in a DBExpress dataset.
TSQLTimeStampOffsetFieldTSQLTimeStampOffsetField represents a date-time value with a high degree of accuracy field in a dataset.
TStringFieldTStringField represents a string field in a dataset.
TTimeFieldTTimeField represents a time field in a dataset.
TUnsignedAutoIncFieldTUnsignedAutoIncField is a persistent field object for an auto-increment unsigned integer value field in a dataset.
TVarBytesFieldTVarBytesField represents a variable-length untyped binary field in a dataset.
TVariantFieldTVariantField represents a variant field in a dataset.
TWideMemoFieldTWideMemoField represents a memo field in a dataset.
TWideStringFieldTWideStringField represents a large string field in a dataset.
TWordFieldRepresents an unsigned 16-bit integer field in a dataset.

Routines

BuffersEqualIndicates whether two buffers have the same contents.
DatabaseErrorCreates and raises an EDatabaseError exception.
DatabaseErrorFmtCreates and raises an EDatabaseError exception with a formatted error message.
DisposeMemFrees memory.
ExtractFieldNameReturns the next name in a semicolon-delimited string of field names.
GetFieldPropertyReturns a TField object for a dataset and data control.
RegisterFieldsRegisters a set of field components so that they appear in the Dataset designer.
VarTypeToDataTypeReturns the field type value that most closely corresponds to a Variant type.

Types

Data_Db
Data_Db__37
Data_Db__57
Data_Db__77
LargeintLargeint is an alias for Int64.
PBookmarkFlagPBookmarkFlag is a pointer to TBookmarkFlag.
PDateTimeRec
PLookupListEntryPLookupListEntry is a pointer to TLookupListEntry.
PPacketAttributePPacketAttribute is a pointer to TPacketAttribute.
TAutoRefreshFlagTAutoRefreshFlag Indicates whether the server provides field values, and if so, why.
TBlobByteDataTBlobByteData stores the contents of a Binary Large Object (BLOB) field.
TBlobDataTBlobData is an alias for TBytes that is used in conjunction with BLOB operations.
TBlobDisplayValueDefines an enumeration used to control the behavior of TBlobField in the DB-aware controls (such as TDBGrid or TDBEdit).
TBlobStreamModeTBlobStreamMode indicates how a BLOB stream can be used.
TBlobTypeTBlobType indicates the type of a BLOB field.
TBookmarkTBookmark identifies a record in a dataset for later navigation.
TBookmarkFlagTBookmarkFlag is a set that is used internally.
TBookmarkStrTBookmarkStr is a bookmark represented as a string.
TBufferListRepresents a list of buffers.
TBufList
TConnectChangeEventType of function called when connection changes.
TDataActionTDataAction indicates how an application should respond to a database error condition.
TDataChangeEventOnDataChange event handler type.
TDataEventTDataEvent identifies an event that occurs to a dataset.
TDataOperationProcedure of object internally used by Data.DB.TDataSet.
TDataSetCommandStatesSet used to specify the states of a command.
TDataSetErrorEventTDataSetErrorEvent is the type of event handler that occurs when TDataSet raises an exception.
TDataSetNotifyEventTDataSetNotifyEvent notifies the TDataSet that an event has occurred.
TDataSetStateTDataSetState indicates the current operating mode of a dataset component.
TDateTimeAliasTDateTimeAlias is an alias for Double.
TDateTimeRecTDateTimeRec represents a record holding date-time information.
TDBScreenCursorTDBScreenCursor is a set that specifies the form of the mouse cursor over the screen.
TDefUpdateMethodProcedure of object used by TDefCollection.UpdateDefs.
TFieldAttributeTFieldAttribute and TFieldAttributes indicate various attributes of a field.
TFieldAttributesTFieldAttributes is a set of TFieldAttribute that indicates various field attributes.
TFieldCharsTFieldChars indicates the set of characters that are valid for field.
TFieldGetTextEventTFieldGetTextEvent is the type for event handlers that assign a field's value from a string.
TFieldKindTFieldKind indicates what type of information a field component represents.
TFieldKindsTFieldKinds is a set of TFieldKind.
TFieldLifeCycleIndicates the possible field types when the dataset is created.
TFieldLifeCyclesRepresents a set of types of fields for the field list.
TFieldNotifyEventTFieldNotifyEvent notifies the dataset field that an event has occurred.
TFieldRefTFieldRef is a pointer to TField.
TFieldsAutoCreationModeEnumerates the behaviors for creating the automatic fields.
TFieldSetTextEventTFieldSetTextEvent is the type for event handlers that assign a field's value from a string.
TFieldsPositionModeEnumerates the positions of the automatic fields relatively to the existing persistent fields.
TFieldTypeTFieldType is a set of values that parallels the data types of fields in tables.
TFieldTypes
TFilterOptionTFilterOption and TFilterOptions influence how filter strings are applied.
TFilterOptionsTFilterOptions is a set of TFilterOption.
TFilterRecordEventEvent handler that issues an OnFilterRecord event.
TGetModeTGetMode is a set that is used to specify the record retrieval mode for the GetRecord method.
TGetResultTGetResult is a set that is used to specify the results for the GetRecord method.
TGroupPosIndTGroupPosInd and TGroupPosInds indicate the position of the current record within its group.
TGroupPosIndsTGroupPosInds is a set of TGroupPosInd.
TIndexOptionTIndexOption describes the attributes of an index.
TIndexOptionsTIndexOptions describes the attributes of an index.
TLocateOptionTLocateOption defines the values for the Options parameter of a dataset's Locate method.
TLocateOptionsTLocateOptions defines the values for the Options parameter of the Locate method of a dataset.
TLookupListEntryTLookupListEntry is a record that holds key-value entries in a lookup list.
TPacketAttributeTPacketAttribute specifies metadata associated with a DataPacket.
TParamTypeTParamType and TParamTypes represent the use of parameters on datasets that represent queries or stored procedures.
TParamTypesTParamTypes is a set of TParamType.
TProviderFlagTProviderFlag and TProviderFlags indicate how a provider uses a field value when applying updates.
TProviderFlagsTProviderFlags is a set of TProviderFlag.
TPSCommandTypeEnumeration of command types.
TRecBufTRecBuf is a NativeInt that allows to access record buffers in a TDataSet.
TRecordBufferRepresents a pointer to a memory zone used as a buffer.
TResyncModeTResyncMode is a set of flags that indicate operations a dataset should perform when resynchronizing data.
TSQLCommandTypeTSQLCommandType indicates how an SQL dataset specifies the command it executes.
TUpdateActionTUpdateAction Indicates how a dataset should proceed after an event handler has processed an update.
TUpdateErrorEventTUpdateErrorEvent is the event that occurs when errors appear during the update action.
TUpdateKindTUpdateKind defines the values for the UpdateKind parameter of OnUpdateError and OnUpdateRecord event handlers.
TUpdateModeTUpdateMode indicates how to locate records so that they can be updated.
TUpdateRecordEventTUpdateRecordEvent is the event handler that updates the records of a dataset.
TUpdateRecordTypesTUpdateRecordTypes is a set that specifies the update status that is applied to a record.
TUpdateStatusTUpdateStatus indicates the update status of a record.
TUpdateStatusSetTUpdateStatusSet is a set of TUpdateStatus.
TValueBuffer

Variables

DBApplicationVariable used to reference DBScreen as IDBApplication.
DBScreenVariable used to initialize the TDefaultDBScreenApplication class.
DefaultCheckConstraintClassVariable of TCheckConstraintClass type used as result value for TCheckConstraints.GetCheckConstraintClass.
DefaultCheckConstraintsClassVariable of TCheckConstraintsClass type used as a result value for TDataSet.GetCheckConstraintsClass.
DefaultFieldClassesArray that holds references to field classes according to field types.
DefaultFieldDefClassVariable of TFieldDefClass type used as a result value for TFieldDefs.GetFieldDefClass.
DefaultFieldDefListClassVariable of TFieldDefListClass type used as a result value for TDataSet.GetFieldDefListClass.
DefaultFieldDefsClassVariable of TFieldDefsClass type used as a result value for TFieldDef.GetChildDefsClass.
DefaultFieldListClassVariable of TFieldListClass type used as a result value for TDataSet.GetFieldListClass.
DefaultFieldsClassVariable of TFieldsClass type used as a result value for TDataSet.GetFieldsClass.
DefaultIndexDefClassVariable of TIndexDefClass type used as a result value for TIndexDefs.GetIndexDefClass.
DefaultIndexDefsClassVariable of TIndexDefsClass type used as a result value for TDataSet.GetIndexDefsClass.
DefaultLookupListClassVariable of TLookupListClass type used as a result value for TField.GetLookupListClass.
DefaultParamClassVariable of TParamClass type used as a result value for TParams.GetParamClass.
DefaultParamsClassVariable of TParamsClass type used as a result value for GetParamsClass.
FieldTypeNames
FieldTypeVarMap
LoginDialogExProcSet this variable to specify a method that will provide login information.
LoginDialogProcSet this variable to specify a method that will provide login information.
PasswordDialogDisplays a dialog box that prompts the user for the password of a local password-protected table.
RegisterFieldsProcInternally used by the DB design packages.
RemoteLoginDialogProcSet this variable to specify a method that will provide login information.
ScreenCursorProcSpecifies a method to change the screen cursor.

Constants

dsEditModesdsEditModes: Set = [dsEdit..dsSetKey];
dsGuidStringLengthdsGuidStringLength: Integer = $26;
dsMaxStringSizedsMaxStringSize: Integer = $2000;
dsWriteModesdsWriteModes: Set = [dsEdit..dsNewValue,dsInternalCalc];
ftCalcFieldTypesftCalcFieldTypes: Set = [ftString..ftVarBytes,ftFixedChar..ftLargeint,ftGuid..ftFixedWideChar,ftOraTimeStamp..ftExtended,ftTimeStampOffset,ftSingle];
ftFixedSizeTypesftFixedSizeTypes: Set = [ftSmallint..ftCurrency,ftDate..ftDateTime,ftAutoInc,ftLargeint,ftTimeStamp,ftLongWord..ftExtended,ftTimeStampOffset,ftSingle];
ftNonTextTypesftNonTextTypes: Set = [ftBytes..ftVarBytes,ftBlob..ftCursor,ftADT..ftDataSet];
ObjectFieldTypesObjectFieldTypes: Set = [ftADT..ftDataSet];
sApplyUpdatesDataSetCommandsApplyUpdatesDataSetCommand: string = ApplyUpdates;
sCancelUpdatesDataSetCommandsCancelUpdatesDataSetCommand: string = CancelUpdates;