The db3 Reference Manual

Table of Contents

The db3 Reference Manual

This is the db3 Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Feb 19 19:39:14 2020 GMT+0.

1 Introduction

DB3

A lib to read dbf files version 3.

Database file structure

The structure of a dBASE III database file is composed of a header and data records. The layout is given below.

dBASE III DATABASE FILE HEADER:

+---------+-------------------+---------------------------------+
|  BYTE   |     CONTENTS      |          MEANING                |
+---------+-------------------+---------------------------------+
|  0      |  1 byte           | dBASE III version number        |
|         |                   |  (03H without a .DBT file)      |
|         |                   |  (83H with a .DBT file)         |
+---------+-------------------+---------------------------------+
|  1-3    |  3 bytes          | date of last update             |
|         |                   |  (YY MM DD) in binary format    |
+---------+-------------------+---------------------------------+
|  4-7    |  32 bit number    | number of records in data file  |
+---------+-------------------+---------------------------------+
|  8-9    |  16 bit number    | length of header structure      |
+---------+-------------------+---------------------------------+
|  10-11  |  16 bit number    | length of the record            |
+---------+-------------------+---------------------------------+
|  12-31  |  20 bytes         | reserved bytes (version 1.00)   |
+---------+-------------------+---------------------------------+
|  32-n   |  32 bytes each    | field descriptor array          |
|         |                   |  (see below)                    | --+
+---------+-------------------+---------------------------------+   |
|  n+1    |  1 byte           | 0DH as the field terminator     |   |
+---------+-------------------+---------------------------------+   |
                                                                    |
                                                                    |
A FIELD DESCRIPTOR:      <------------------------------------------+

+---------+-------------------+---------------------------------+
|  BYTE   |     CONTENTS      |          MEANING                |
+---------+-------------------+---------------------------------+
|  0-10   |  11 bytes         | field name in ASCII zero-filled |
+---------+-------------------+---------------------------------+
|  11     |  1 byte           | field type in ASCII             |
|         |                   |  (C N L D or M)                 |
+---------+-------------------+---------------------------------+
|  12-15  |  32 bit number    | field data address              |
|         |                   |  (address is set in memory)     |
+---------+-------------------+---------------------------------+
|  16     |  1 byte           | field length in binary          |
+---------+-------------------+---------------------------------+
|  17     |  1 byte           | field decimal count in binary   |
+---------+-------------------+---------------------------------+
|  18-31  |  14 bytes         | reserved bytes (version 1.00)   |
+---------+-------------------+---------------------------------+

The data records are layed out as follows:

1. Data records are preceeded by one byte that is a space (20H) if the record is not deleted and an asterisk (2AH) if it is deleted.

2. Data fields are packed into records with no field separators or record terminators.

3. Data types are stored in ASCII format as follows:

   DATA TYPE      DATA RECORD STORAGE
   ---------      --------------------------------------------
   Character      (ASCII characters)
   Numeric        - . 0 1 2 3 4 5 6 7 8 9
   Logical        ? Y y N n T t F f  (? when not initialized)
   Memo           (10 digits representing a .DBT block number)
   Date           (8 digits in YYYYMMDD format, such as
                    19840704 for July 4, 1984)
   -----------------------------------------------------------
   

Initial support for Memo files

Dbase memo files seem to be like their own kind of fun. Initial attempt at providing support for them has been hacked together for dBase III+ versions. dBase IV are said to be using a different formating, with per-block block size and type.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 db3

Author

Xach

License

WTFPL

Description

DB3 file reader

Source

db3.asd (file)

Components

• package.lisp (file)
• db3.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 db3.asd

Location

db3.asd

Systems

db3 (system)

3.1.2 db3/package.lisp

Parent

db3 (system)

Location

package.lisp

Packages

db3

3.1.3 db3/db3.lisp

Dependencies

• package.lisp (file)
• package.lisp (file)

Parent

db3 (system)

Location

db3.lisp

Exported Definitions

• *external-format* (special variable)
• close-memo (method)
• db3 (class)
• dump-db3 (function)
• load-header (method)
• load-record (method)
• record-count (method)
• (setf record-count) (method)
• sample-db3 (function)
• write-record (function)

Internal Definitions

• *code-page-list* (special variable)
• ascii->string (function)
• asciiz->string (function)
• block-data (method)
• (setf block-data) (method)
• block-size (method)
• (setf block-size) (method)
• block-size (method)
• (setf block-size) (method)
• block-type (method)
• (setf block-type) (method)
• bytes->bigint (function)
• bytes->integer (function)
• convert-field (method)
• convert-field (method)
• convert-field (method)
• convert-field (method)
• convert-field (method)
• convert-field (method)
• convert-field (method)
• convert-field (method)
• data-address (method)
• (setf data-address) (method)
• db3-field (class)
• db3-memo (class)
• db3-memo-block (class)
• db3-memo-stream (method)
• (setf db3-memo-stream) (method)
• encoding (method)
• (setf encoding) (method)
• field-count (method)
• field-count (method)
• (setf field-count) (method)
• field-length (method)
• (setf field-length) (method)
• field-name (method)
• (setf field-name) (method)
• field-type (method)
• (setf field-type) (method)
• fields (method)
• (setf fields) (method)
• filename (method)
• (setf filename) (method)
• filename (method)
• (setf filename) (method)
• header-length (method)
• (setf header-length) (method)
• inspect-db3 (function)
• language-driver-to-encoding (function)
• last-update (method)
• (setf last-update) (method)
• load-field (method)
• load-field-descriptor (function)
• load-memo-header (method)
• load-memo-record (method)
• memo (method)
• (setf memo) (method)
• next-block (method)
• (setf next-block) (method)
• read-uint16 (function)
• read-uint32 (function)
• record-length (method)
• (setf record-length) (method)
• unsigned-to-signed (function)
• version-number (method)
• (setf version-number) (method)

4 Packages

Packages are listed by definition order.

4.1 db3

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• *external-format* (special variable)
• close-memo (generic function)
• close-memo (method)
• db3 (class)
• dump-db3 (function)
• load-header (generic function)
• load-header (method)
• load-record (generic function)
• load-record (method)
• record-count (generic function)
• record-count (method)
• (setf record-count) (method)
• (setf record-count) (generic function)
• sample-db3 (function)
• write-record (function)

Internal Definitions

• *code-page-list* (special variable)
• ascii->string (function)
• asciiz->string (function)
• block-data (generic function)
• block-data (method)
• (setf block-data) (method)
• (setf block-data) (generic function)
• block-size (generic function)
• block-size (method)
• (setf block-size) (method)
• block-size (method)
• (setf block-size) (method)
• (setf block-size) (generic function)
• block-type (generic function)
• block-type (method)
• (setf block-type) (method)
• (setf block-type) (generic function)
• bytes->bigint (function)
• bytes->integer (function)
• convert-field (generic function)
• convert-field (method)
• convert-field (method)
• convert-field (method)
• convert-field (method)
• convert-field (method)
• convert-field (method)
• convert-field (method)
• convert-field (method)
• data-address (generic function)
• data-address (method)
• (setf data-address) (method)
• (setf data-address) (generic function)
• db3-field (class)
• db3-memo (class)
• db3-memo-block (class)
• db3-memo-stream (generic function)
• db3-memo-stream (method)
• (setf db3-memo-stream) (method)
• (setf db3-memo-stream) (generic function)
• encoding (generic function)
• encoding (method)
• (setf encoding) (method)
• (setf encoding) (generic function)
• field-count (generic function)
• field-count (method)
• field-count (method)
• (setf field-count) (method)
• (setf field-count) (generic function)
• field-length (generic function)
• field-length (method)
• (setf field-length) (method)
• (setf field-length) (generic function)
• field-name (generic function)
• field-name (method)
• (setf field-name) (method)
• (setf field-name) (generic function)
• field-type (generic function)
• field-type (method)
• (setf field-type) (method)
• (setf field-type) (generic function)
• fields (generic function)
• fields (method)
• (setf fields) (method)
• (setf fields) (generic function)
• filename (generic function)
• filename (method)
• (setf filename) (method)
• filename (method)
• (setf filename) (method)
• (setf filename) (generic function)
• header-length (generic function)
• header-length (method)
• (setf header-length) (method)
• (setf header-length) (generic function)
• inspect-db3 (function)
• language-driver-to-encoding (function)
• last-update (generic function)
• last-update (method)
• (setf last-update) (method)
• (setf last-update) (generic function)
• load-field (generic function)
• load-field (method)
• load-field-descriptor (function)
• load-memo-header (generic function)
• load-memo-header (method)
• load-memo-record (generic function)
• load-memo-record (method)
• memo (generic function)
• memo (method)
• (setf memo) (method)
• (setf memo) (generic function)
• next-block (generic function)
• next-block (method)
• (setf next-block) (method)
• (setf next-block) (generic function)
• read-uint16 (function)
• read-uint32 (function)
• record-length (generic function)
• record-length (method)
• (setf record-length) (method)
• (setf record-length) (generic function)
• unsigned-to-signed (function)
• version-number (generic function)
• version-number (method)
• (setf version-number) (method)
• (setf version-number) (generic function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *external-format*

External format of the DBF file Character data

Package

db3

Source

db3.lisp (file)

5.1.2 Functions

Function: dump-db3 INPUT OUTPUT

Package

db3

Source

db3.lisp (file)

Function: sample-db3 INPUT OSTREAM &key SAMPLE-SIZE

Package

db3

Source

db3.lisp (file)

Function: write-record RECORD STREAM

Package

db3

Source

db3.lisp (file)

5.1.3 Generic functions

Generic Function: close-memo DB3

Package

db3

Methods

Method: close-memo (DB3 db3)

Source

db3.lisp (file)

Generic Function: load-header DB3 STREAM

Package

db3

Methods

Method: load-header (DB3 db3) STREAM

Source

db3.lisp (file)

Generic Function: load-record DB3 STREAM

Package

db3

Methods

Method: load-record (DB3 db3) STREAM

Source

db3.lisp (file)

Generic Function: record-count OBJECT

Generic Function: (setf record-count) NEW-VALUE OBJECT

Package

db3

Methods

Method: record-count (DB3 db3)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf record-count) NEW-VALUE (DB3 db3)

automatically generated writer method

Source

db3.lisp (file)

5.1.4 Classes

Class: db3 ()

Package

db3

Source

db3.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• load-record (method)
• load-field (method)
• close-memo (method)
• load-memo-record (method)
• load-memo-header (method)
• load-header (method)
• field-count (method)
• fields (method)
• fields (method)
• encoding (method)
• encoding (method)
• record-length (method)
• record-length (method)
• header-length (method)
• header-length (method)
• record-count (method)
• record-count (method)
• last-update (method)
• last-update (method)
• version-number (method)
• version-number (method)
• memo (method)
• memo (method)
• filename (method)
• filename (method)

Direct slots

Slot: filename

Initargs

:filename

Readers

filename (generic function)

Writers

(setf filename) (generic function)

Slot: memo

Readers

memo (generic function)

Writers

(setf memo) (generic function)

Slot: version-number

Readers

version-number (generic function)

Writers

(setf version-number) (generic function)

Slot: last-update

Readers

last-update (generic function)

Writers

(setf last-update) (generic function)

Slot: record-count

Readers

record-count (generic function)

Writers

(setf record-count) (generic function)

Slot: header-length

Readers

header-length (generic function)

Writers

(setf header-length) (generic function)

Slot: record-length

Readers

record-length (generic function)

Writers

(setf record-length) (generic function)

Slot: encoding

Readers

encoding (generic function)

Writers

(setf encoding) (generic function)

Slot: fields

Readers

fields (generic function)

Writers

(setf fields) (generic function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *code-page-list*

Package

db3

Source

db3.lisp (file)

5.2.2 Functions

Function: ascii->string ARRAY

Package

db3

Source

db3.lisp (file)

Function: asciiz->string ARRAY

Package

db3

Source

db3.lisp (file)

Function: bytes->bigint DATA

Package

db3

Source

db3.lisp (file)

Function: bytes->integer DATA

Package

db3

Source

db3.lisp (file)

Function: inspect-db3 INPUT OSTREAM &key SAMPLE-SIZE

Package

db3

Source

db3.lisp (file)

Function: language-driver-to-encoding LANGUAGE-DRIVER

Package

db3

Source

db3.lisp (file)

Function: load-field-descriptor STREAM

Package

db3

Source

db3.lisp (file)

Function: read-uint16 STREAM

Package

db3

Source

db3.lisp (file)

Function: read-uint32 STREAM

Package

db3

Source

db3.lisp (file)

Function: unsigned-to-signed BYTE N

Package

db3

Source

db3.lisp (file)

5.2.3 Generic functions

Generic Function: block-data OBJECT

Generic Function: (setf block-data) NEW-VALUE OBJECT

Package

db3

Methods

Method: block-data (DB3-MEMO-BLOCK db3-memo-block)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf block-data) NEW-VALUE (DB3-MEMO-BLOCK db3-memo-block)

automatically generated writer method

Source

db3.lisp (file)

Generic Function: block-size OBJECT

Generic Function: (setf block-size) NEW-VALUE OBJECT

Package

db3

Methods

Method: block-size (DB3-MEMO-BLOCK db3-memo-block)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf block-size) NEW-VALUE (DB3-MEMO-BLOCK db3-memo-block)

automatically generated writer method

Source

db3.lisp (file)

Method: block-size (DB3-MEMO db3-memo)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf block-size) NEW-VALUE (DB3-MEMO db3-memo)

automatically generated writer method

Source

db3.lisp (file)

Generic Function: block-type OBJECT

Generic Function: (setf block-type) NEW-VALUE OBJECT

Package

db3

Methods

Method: block-type (DB3-MEMO-BLOCK db3-memo-block)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf block-type) NEW-VALUE (DB3-MEMO-BLOCK db3-memo-block)

automatically generated writer method

Source

db3.lisp (file)

Generic Function: convert-field DB3 TYPE DATA

Package

db3

Methods

Method: convert-field DB3 (TYPE (eql m)) DATA

Source

db3.lisp (file)

Method: convert-field DB3 (TYPE (eql c)) DATA

Source

db3.lisp (file)

Method: convert-field DB3 (TYPE (eql f)) DATA

Source

db3.lisp (file)

Method: convert-field DB3 (TYPE (eql y)) DATA

Source

db3.lisp (file)

Method: convert-field DB3 (TYPE (eql +)) DATA

Source

db3.lisp (file)

Method: convert-field DB3 (TYPE (eql i)) DATA

Source

db3.lisp (file)

Method: convert-field DB3 (TYPE (eql 0)) DATA

Source

db3.lisp (file)

Method: convert-field DB3 TYPE DATA

Source

db3.lisp (file)

Generic Function: data-address OBJECT

Generic Function: (setf data-address) NEW-VALUE OBJECT

Package

db3

Methods

Method: data-address (DB3-FIELD db3-field)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf data-address) NEW-VALUE (DB3-FIELD db3-field)

automatically generated writer method

Source

db3.lisp (file)

Generic Function: db3-memo-stream OBJECT

Generic Function: (setf db3-memo-stream) NEW-VALUE OBJECT

Package

db3

Methods

Method: db3-memo-stream (DB3-MEMO db3-memo)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf db3-memo-stream) NEW-VALUE (DB3-MEMO db3-memo)

automatically generated writer method

Source

db3.lisp (file)

Generic Function: encoding OBJECT

Generic Function: (setf encoding) NEW-VALUE OBJECT

Package

db3

Methods

Method: encoding (DB3 db3)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf encoding) NEW-VALUE (DB3 db3)

automatically generated writer method

Source

db3.lisp (file)

Generic Function: field-count OBJECT

Generic Function: (setf field-count) NEW-VALUE OBJECT

Package

db3

Methods

Method: field-count (DB3 db3)

Source

db3.lisp (file)

Method: field-count (DB3-FIELD db3-field)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf field-count) NEW-VALUE (DB3-FIELD db3-field)

automatically generated writer method

Source

db3.lisp (file)

Generic Function: field-length OBJECT

Generic Function: (setf field-length) NEW-VALUE OBJECT

Package

db3

Methods

Method: field-length (DB3-FIELD db3-field)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf field-length) NEW-VALUE (DB3-FIELD db3-field)

automatically generated writer method

Source

db3.lisp (file)

Generic Function: field-name OBJECT

Generic Function: (setf field-name) NEW-VALUE OBJECT

Package

db3

Methods

Method: field-name (DB3-FIELD db3-field)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf field-name) NEW-VALUE (DB3-FIELD db3-field)

automatically generated writer method

Source

db3.lisp (file)

Generic Function: field-type OBJECT

Generic Function: (setf field-type) NEW-VALUE OBJECT

Package

db3

Methods

Method: field-type (DB3-FIELD db3-field)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf field-type) NEW-VALUE (DB3-FIELD db3-field)

automatically generated writer method

Source

db3.lisp (file)

Generic Function: fields OBJECT

Generic Function: (setf fields) NEW-VALUE OBJECT

Package

db3

Methods

Method: fields (DB3 db3)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf fields) NEW-VALUE (DB3 db3)

automatically generated writer method

Source

db3.lisp (file)

Generic Function: filename OBJECT

Generic Function: (setf filename) NEW-VALUE OBJECT

Package

db3

Methods

Method: filename (DB3-MEMO db3-memo)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf filename) NEW-VALUE (DB3-MEMO db3-memo)

automatically generated writer method

Source

db3.lisp (file)

Method: filename (DB3 db3)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf filename) NEW-VALUE (DB3 db3)

automatically generated writer method

Source

db3.lisp (file)

Generic Function: header-length OBJECT

Generic Function: (setf header-length) NEW-VALUE OBJECT

Package

db3

Methods

Method: header-length (DB3 db3)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf header-length) NEW-VALUE (DB3 db3)

automatically generated writer method

Source

db3.lisp (file)

Generic Function: last-update OBJECT

Generic Function: (setf last-update) NEW-VALUE OBJECT

Package

db3

Methods

Method: last-update (DB3 db3)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf last-update) NEW-VALUE (DB3 db3)

automatically generated writer method

Source

db3.lisp (file)

Generic Function: load-field DB3 FIELD STREAM

Package

db3

Methods

Method: load-field (DB3 db3) (FIELD db3-field) STREAM

Source

db3.lisp (file)

Generic Function: load-memo-header DB3

Package

db3

Methods

Method: load-memo-header (DB3 db3)

Source

db3.lisp (file)

Generic Function: load-memo-record DB3 DATA

Package

db3

Methods

Method: load-memo-record (DB3 db3) DATA

Source

db3.lisp (file)

Generic Function: memo OBJECT

Generic Function: (setf memo) NEW-VALUE OBJECT

Package

db3

Methods

Method: memo (DB3 db3)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf memo) NEW-VALUE (DB3 db3)

automatically generated writer method

Source

db3.lisp (file)

Generic Function: next-block OBJECT

Generic Function: (setf next-block) NEW-VALUE OBJECT

Package

db3

Methods

Method: next-block (DB3-MEMO db3-memo)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf next-block) NEW-VALUE (DB3-MEMO db3-memo)

automatically generated writer method

Source

db3.lisp (file)

Generic Function: record-length OBJECT

Generic Function: (setf record-length) NEW-VALUE OBJECT

Package

db3

Methods

Method: record-length (DB3 db3)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf record-length) NEW-VALUE (DB3 db3)

automatically generated writer method

Source

db3.lisp (file)

Generic Function: version-number OBJECT

Generic Function: (setf version-number) NEW-VALUE OBJECT

Package

db3

Methods

Method: version-number (DB3 db3)

automatically generated reader method

Source

db3.lisp (file)

Method: (setf version-number) NEW-VALUE (DB3 db3)

automatically generated writer method

Source

db3.lisp (file)

5.2.4 Classes

Class: db3-field ()

Package

db3

Source

db3.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• load-field (method)
• field-count (method)
• field-count (method)
• field-length (method)
• field-length (method)
• data-address (method)
• data-address (method)
• field-type (method)
• field-type (method)
• field-name (method)
• field-name (method)

Direct slots

Slot: name

Readers

field-name (generic function)

Writers

(setf field-name) (generic function)

Slot: type

Readers

field-type (generic function)

Writers

(setf field-type) (generic function)

Slot: data-address

Readers

data-address (generic function)

Writers

(setf data-address) (generic function)

Slot: field-length

Readers

field-length (generic function)

Writers

(setf field-length) (generic function)

Slot: field-count

Readers

field-count (generic function)

Writers

(setf field-count) (generic function)

Class: db3-memo ()

Package

db3

Source

db3.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• block-size (method)
• block-size (method)
• next-block (method)
• next-block (method)
• db3-memo-stream (method)
• db3-memo-stream (method)
• filename (method)
• filename (method)

Direct slots

Slot: filename

Initargs

:filename

Readers

filename (generic function)

Writers

(setf filename) (generic function)

Slot: stream

Readers

db3-memo-stream (generic function)

Writers

(setf db3-memo-stream) (generic function)

Slot: next-block

Readers

next-block (generic function)

Writers

(setf next-block) (generic function)

Slot: block-size

Readers

block-size (generic function)

Writers

(setf block-size) (generic function)

Class: db3-memo-block ()

Package

db3

Source

db3.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• block-data (method)
• block-data (method)
• block-size (method)
• block-size (method)
• block-type (method)
• block-type (method)

Direct slots

Slot: type

Readers

block-type (generic function)

Writers

(setf block-type) (generic function)

Slot: size

Readers

block-size (generic function)

Writers

(setf block-size) (generic function)

Slot: data

Initargs

:data

Readers

block-data (generic function)

Writers

(setf block-data) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types