Database field type

From Lazarus wiki
Revision as of 10:45, 27 August 2011 by BigChimp (talk | contribs)
Jump to navigationJump to search

Overview

FCL-DB database fields can have different data types. In datasets, a subset of these types is available. What types are supported differ per dataset type.

Types

Currently, the following field types are defined: See FCL field type documentation To do: add assignment information (e.g. can you use .AsString) and additional information below.

ftADT:

ftArray:

ftAutoInc: an autoincrementing integer field.

ftBCD: a binary coded decimal floating point value

ftBlob: a binary large object (BLOB), meant to store arbitrary binary data.

ftBoolean: a boolean value (yes/no).

ftBytes: presumably a number of bytes stored as-is. Needs to have its Size property set to work.

ftCurrency: a format to precisely store currency values.

ftCursor:

ftDBaseOle: presumably meant to store OLE objects in a DBase database. Needs to have its Size property set to work.

ftDataSet: presumably meant to store an entire dataset (possibly to implement master/detail table).

ftDate: a date without time information.

ftDateTime: date and time information.

ftFMTBcd: Needs to have its Size property set to work.

ftFixedChar: a fixed width character field, similar to a Pascal shortstring. Needs to have its Size property set to work.

ftFixedWideChar: a fixed width multibyte character field. Needs to have its Size property set to work.

ftFloat: a floating point numeric type.

ftFmtMemo: Needs to have its Size property set to work.

ftGraphic: Needs to have its Size property set to work.

ftGuid: a field used to store a GUID (Globally Unique Identifier). With the current code, this field needs to have its Size property set to 38.

ftIDispatch:

ftInteger: an integer field

ftInterface:

ftLargeint: a field that contains an integer, stores more bytes than an integer and therefore has a larger range.

ftMemo: stores a variable amount of string/text data; needs no size set.

ftOraBlob: presumably stores Oracle BLOB.

ftOraClob: presumably stores Oracle CLOB: an Oracle data type that can hold up to 4 GB of data [1]

ftParadoxOle: presumably meant to store OLE objects in a Paradox database.

ftReference:

ftSmallint: an integer type field with less bytes than ftInteger.

ftString: stores string data; needs to have its Size property set to the maximum number of characters possible in that field.

ftTime: stores time-only data.

ftTimeStamp: stores date/time data. Probably equivalent to ftDateTime

ftTypedBinary: some kind of blob-like field?

ftUnknown:

ftVarBytes: presumably a variant with byte/binary data?

ftVariant: presumably meant to store variant data.

ftWideMemo: presumably an ftMemo with multibyte characters.

ftWideString: presumably an ftString with multibyte characters.

ftWord: presumably stores an integer value

Note that for string type fields, Size indicates the number of characters that can be stored. DataSize indicates the field size in bytes. If you use multibyte characters like UTF8 or UTF16 do, DataSize and Size do not mean the same thing. If you use only ANSI/ASCII characters, DataSize and Size are effectively the same thing.

Defining types in your dataset

Todo: write me. Explain various ways of doing things (TFieldDef, TFields) and which dataset supports which methods.

Assigning and retrieving values

Once you have the fields in your dataset defined, you can assign and retrieve data like this - suppose you have a dataset called FTestDataset: <delphi>

 FTestDataset.Open; //Open for viewing/editing/inserting
 FTestDataset.Append;
 FTestDataset.Fieldbyname('YourFieldName').Asstring := 'This is my field data'; //Suppose field YourFieldName is a memo field
 FTestDataset.Post; //"Commit"/save changes in the record to the dataset.
 writeln('YourFieldName has data:' + FTestDataset.Fieldbyname('YourFieldName').Asstring 
 { Retrieve the field value of the current record. Because we haven't moved the record, we should get what we just entered }

</delphi> For text/memo fields, use the AsString method. For date/time fields, use the AsDateTime method. For binary fields, I suppose you can use the AsString method - but there must be another way, too

See also