Module `Dbase4.Base`Source

Sourcetype dbf_file = {

name : string;
(*
name of table (.dbf)
*)
fin : in_channel;
(*
opened i/o stream for dbf file
*)
memo : in_channel option;
(*
optional i/o stream for memo file - if exists
*)
info : dbf_info;
(*
description of DBF table
*)
cri : int;
(*
Current Rider Index - ID of current record in the table
*)

}

DBF file handle

Sourceand dbf_info = {

version : int;
(*
version of the file format
*)
mdate : date;
(*
modification date
*)
num_records : int;
(*
number of records
*)
hdr_size : int;
(*
file header size (in bytes)
*)
rec_size : int;
(*
file record size (in bytes)
*)
fields : dbf_field_descriptor array;
(*
fields descriptors
*)

}

descriptor of the internal dbf file layout

Sourceand date = {

year : int;
month : int;
day : int;

}

primitive structure to hold date

Sourceand dbf_field_descriptor = {

name : string;
(*
name of field
*)
ftype : dbf_data_type;
(*
DBF data type
*)
faddr : int;
(*
address of field - it's using as offset in the raw record
*)
flen : int;
(*
length of field
*)
fdec : int;
(*
number after point for number data type
*)
work_area_id : int;
(*
reserved
*)
flags : int;
(*
some flags (not used)
*)

}

DBF field descriptor

Sourceand dbf_data_type =

| Character
(*
character (flen = 1) or string
*)
| Number
(*
number: integer (fdec = 0) or fixed point real
*)
| Float
(*
32-bits floating point number
*)
| Date
(*
date
*)
| Logical
(*
boolean / logical value
*)
| Memo
(*
Text Large Object or Binary Large Object
*)
| General of int
(*
user-defined
*)

internal DBF data type

Sourceexception DbfDataInvalid of string

Exception means: internal data representation is invalid

Sourceval dbf_open : string -> dbf_file

open DBF-file

Sourceval dbf_close : dbf_file -> unit

close DBF-file

Sourceval db_goto : dbf_file -> int -> dbf_file

move cursor to the n-th record, absolute

Sourceval db_skip : dbf_file -> int -> dbf_file

move cursor to the record after n-th records from the current, relative

Sourceval db_go_top : dbf_file -> dbf_file

move to the first record

Sourceval db_go_bottom : dbf_file -> dbf_file

move to the last record

Sourceval db_bof : dbf_file -> bool

check the end of file

Sourceval db_has_memo_fields : dbf_file -> bool

check either has MEMO-extention or not

Sourceval db_memo_exists : string -> string option

Sourceval read_record : ?with_deleted:bool -> dbf_file -> bool * bytes

read raw (undecoded) record

Sourceval iterator : dbf_file -> (int * bool * bytes) Seq.t

make an iterartor over all records

Sourceval all_records : dbf_file -> bytes Seq.t

make an iterartor over all existed (not deleted) records

Sourceval string_of_zstring : string -> string

FOR INTERNAL USE ONLY - translate binary ASCIIZ-string

Sourceval read_chunk : In_channel.t -> int -> bytes

FOR INTERNAL USE ONLY - read chunk of data from the file

package dbase4

Module Dbase4.BaseSource

Module `Dbase4.Base`Source