NexusDB

 
Description

Basic data dictionary.

 
Classes

EnxBaseAutoIncDescriptorException

This is the Exception class for the AutoInc Descriptor. All errors raised because of a problem in a AutoInc Descriptor class use this or a descendent exception class.

EnxBaseBlobDescriptorException

This is the Exception class for the Blob Descriptor. All errors raised because of a problem in a Blob Descriptor class use this or a descendent exception class.

EnxBaseBlockHeapDescriptorException

This is the Exception class for the Block Heap Descriptor. All errors raised because of a problem in a Block Heap Descriptor class use this or a descendent exception class.

EnxBaseDefaultValueDescriptorException

This is the Exception class for the Default Value Descriptor. All errors raised because of a problem in a Default Value Descriptor class use this or a descendent exception class.

EnxBaseDictionaryException

This is the base Exception class for the various data dictionary exceptions.

EnxBaseHeapDescriptorException

This is the Exception class for the Heap Descriptor. All errors raised because of a problem in a Heap Descriptor class use this or a descendent exception class.

EnxBaseIndicesDescriptorException

This is the Exception class for the Indices descriptor. All errors raised because of a problem in a Indices descriptor class use this or a descendent exception class.

EnxBaseKeyDescriptorException

This is the Exception class for the Key Descriptor. All errors raised because of a problem in a Key Descriptor class use this or a descendent exception class.

EnxBaseRecordDescriptorException

This is the Exception class for the Record Descriptor. All errors raised because of a problem in a Record Descriptor class use this or a descendent exception class.

EnxBaseValidationDescriptorException

This is the Exception class for the Validation Descriptor. All errors raised because of a problem in a Validation Descriptor class use this or a descendent exception class.

EnxCompKeyDescriptorException

This is the exception class used for Compound Key descriptors.

EnxConstDefaultValueDescriptorException

The Exception class for the Constant Default Value Descriptor.

EnxCustomDescriptorException

This is the Exception class for Custom Descriptors. All errors raised because of a problem in a Custom Descriptor class use this or a descendent exception class.

EnxDataDictionaryException

This is the Exception class for general, not descriptor based, exceptions of the Data Dictionary.

EnxDictionaryItemException

All exceptions for descriptors are inherited from this.

EnxExtTextKeyFieldDescriptorException

This is the exception class used for Extended Text Key Field descriptors.

EnxFieldDescriptorException

This is the Exception class for the Field Descriptor. All errors raised because of a problem in a Field Descriptor class use this or a descendent exception class.

EnxFieldsDescriptorException

This is the Exception class for the Fields descriptor. All errors raised because of a problem in a Fields descriptor class use this or a descendent exception class.

EnxFileDescriptorException

This is the Exception class for the File descriptor. All errors raised because of a problem in a File descriptor class use this or a descendent exception class.

EnxHeapBlobDescriptorException

This is the exception class used for the Heap Blob Descriptor.

EnxHeapRecordDescriptorException

This is the exception class used for the Heap Record Descriptor.

EnxIndexDescriptorException

This is the Exception class for the Index Descriptor. All errors raised because of a problem in a Key Descriptor class use this or a descendent exception class.

EnxKeyFieldDescriptorException

This is the Exception class for the Key Field Descriptor. All errors raised because of a problem in a Key Field Descriptor class use this or a descendent exception class.

EnxLocaleDescriptorException

This is the Exception class for the Locale descriptor. All errors raised because of a problem in a Locale descriptor class use this or a descendent exception class.

EnxLocaleizedDictionaryItemException

This is the Exception class for a localeized dictionary item. All errors raised because of a problem in a localeized dictionary item class use this or a descendent exception class.

EnxMainIndicesDescriptorException

The text for this class has been generated automatically. This means that it is not documented.

EnxRefKeyDescriptorException

This is the exception class used for Ref Key descriptors.

EnxTextKeyFieldDescriptorException

This is the exception class used for Text Key Field descriptors.

TnxAutoGuidDefaultValueDescriptor

This descriptor should be used if you want to set a Guid field to an automatically created new Guid.

TnxBaseAutoIncDescriptor

This is the base class for AutoInc Descriptors. A AutoInc descriptor specifies the sub-engine that generates the AutoIncs.

TnxBaseBlobDescriptor

This is the base class for BLOB Descriptors. A Blob descriptor specifies the sub-engine that accesses the blobs.

TnxBaseBlockHeapDescriptor

This is the base class for specifying Block management classes. BlockHeap descriptors are used by the Heap Descriptor

TnxBaseCustomDescriptor

A Custom Descriptor is the base class for Custom Descriptors. Developers should use this class as a base fro creating their own Descriptors and store them with tables.

TnxBaseDefaultValueDescriptor

This is the base class for descriptor that describe how a default value of a Field is set. This is an abstract class and must be overridden!

TnxBaseHeapDescriptor

This is the base class for specifying the Heap management classes.

TnxBaseIndicesDescriptor

The text for this class has been generated automatically. This means that it is not documented.

TnxBaseKeyDescriptor

The base class of all Key Descriptors. A Key descriptor is used to create a key out of a record. Mainly it is used for creating indexes, but can of course also be used for other purposes.

TnxBaseRecordDescriptor

This is the base class for Record Descriptors. A record descriptor is used for specifying the Record Engine used to read records from a table.

TnxBaseValidationDescriptor

This is the base class for descriptor that describe how a Field is validated. This is an abstract class and must be overridden!

TnxCompKeyDescriptor

The Compound Key descriptor uses a number of Key Field descriptor to create the keys.

TnxConstDefaultValueDescriptor

This is the implementation for constant default values.

TnxCurrentDateTimeDefaultValueDescriptor

This descriptor should be used if you want to set a DateTime field to the current server DateTime.

TnxDataDictionary

The data dictionary is the heart of every NexusDB table. It describes the files, fields, indices, etc and even how to read/write the records.

If you don't need the fine control that the data dictionary gives you, you can just use TIndexDefs, TFieldDefs and the CreateTable method of TDataset.

TnxDictionaryItem

The dictionary item class is the base class for all sub classes owned by a data dictionary. This includes all the different descriptor classes.

TnxEmptyDefaultValueDescriptor

This descriptor should be used if you want to set a fields default value to not null. The practical result: strings become '' (empty string), integers 0, etc.

By default all fields are NULL if not otherwise set.

TnxExtTextKeyFieldDescriptor

This is an extended version of the Text Key Field descriptor that can also handle Multi bytes characters, locale support, etc.

TnxFieldDescriptor

This descriptor class describes fields. For each field added to the Data Dictionary one instance is created.

TnxFieldsDescriptor

The text for this class has been generated automatically. This means that it is not documented.

TnxFileDescriptor

A file descriptor describes the attributes of a physical file.

TnxHeapBlobDescriptor

A Heap Blob Descriptor adds support to Blob Descriptors for specifying a Heap Descriptor to read/store blobs on a heap.

TnxHeapRecordDescriptor

This is a descendant of Record Descriptor that allows to specify a Heap Descriptor that is used by the specified engine.

TnxIndexDescriptor

An Index Descriptor describes how NexusDB creates an Index for a table. It uses Key Descriptor for creating the record keys and optionally a File Descriptor to describe a sperate file used for storing the index.

TnxKeyFieldDescriptor

A Key Field Descriptor is used by a Key Descriptor to describe how field values processed when creating the key.

TnxLocaleDescriptor

This is the basic locale descriptor. It can be added to the data dictionary, field descriptors and key field descriptors. If a key field descriptor has no locale descriptor attached falls back to the field descriptor. If the field descriptor has no locale descriptor attached it falls back to the data dictionary. If there is no locale descriptor available at all or if the Locale of the used locale descriptor is 0 all comparisons and sorting is performed by direct byte value comparison.

TnxLocalizedDictionaryItem

The text for this class has been generated automatically. This means that it is not documented.

TnxMainIndicesDescriptor

The text for this class has been generated automatically. This means that it is not documented.

TnxRefKeyDescriptor

This Key Descriptor returns the internal id of the record as Key. It is used for the Sequential Access Index.

TnxTextKeyFieldDescriptor

This is a simple Text field version of Key Field descriptor.