absdb

package module

Go to main page

Versions in this module

v0

v0.1.2

Aug 29, 2026

Changes in this version

+ var ErrColumnAutoIncOptions = errors.New("absdb: column carries AUTOINC options this package cannot write")

type GUID

+ func ParseGUID(s string) (GUID, bool)

v0.1.1

Aug 29, 2026

Changes in this version

+ const PageTypeSystem

+ const PageTypeTableInfo

+ const PageTypeTableList

+ var ErrAmbiguousTable = errors.New("absdb: database holds more than one table")

+ var ErrBadCatalog = errors.New("absdb: malformed table catalog")

+ var ErrBadGeometry = errors.New("absdb: invalid database geometry")

+ var ErrBadLayout = errors.New("absdb: record layout does not match the data")

+ var ErrBlobChain = errors.New("absdb: malformed BLOB page chain")

+ var ErrBlobReferenceLost = errors.New("absdb: update would drop a BLOB reference")

+ var ErrBlobSize = errors.New("absdb: BLOB size out of range")

+ var ErrBlobWrite = errors.New("absdb: BLOB and CLOB columns cannot be written yet")

+ var ErrBookkeepingMismatch = errors.New("absdb: stored record counts do not match the records on the page")

+ var ErrCatalogNotWritable = errors.New("absdb: table catalog cannot be rewritten in place")

+ var ErrColumnConstrained = errors.New("absdb: column is named by a constraint this package cannot repair")

+ var ErrColumnDefault = errors.New("absdb: column carries a DEFAULT clause this package cannot write")

+ var ErrColumnExists = errors.New("absdb: column already exists")

+ var ErrColumnIndexed = errors.New("absdb: column is covered by an index this package cannot repair")

+ var ErrColumnNotWritable = errors.New("absdb: column type cannot be written yet")

+ var ErrColumnRange = errors.New("absdb: column index out of range")

+ var ErrConstraintsNotEnforced = errors.New("absdb: table carries constraints this package does not check")

+ var ErrConstraintsNotRebuilt = errors.New("absdb: table carries constraint records a rebuild would lose")

+ var ErrDatabaseTooLarge = errors.New("absdb: database cannot grow past its first allocation map page")

+ var ErrEncryptionUnsupported = errors.New("absdb: creating an encrypted database is not supported")

+ var ErrIndexBacksConstraint = errors.New("absdb: index implements a PRIMARY KEY or UNIQUE constraint")

+ var ErrIndexExists = errors.New("absdb: index already exists")

+ var ErrIndexNotMaintained = errors.New("absdb: table has an index this package cannot maintain")

+ var ErrIndexTooManyRows = errors.New("absdb: table has too many rows for a single-page index")

+ var ErrLastColumn = errors.New("absdb: cannot drop a table's only column")

+ var ErrLastTable = errors.New("absdb: cannot drop the database's only table")

+ var ErrMalformedIndex = errors.New("absdb: malformed index")

+ var ErrMultiColumnIndex = errors.New("absdb: multi-column indexes are not supported")

+ var ErrNoCatalog = errors.New("absdb: no table catalog page found")

+ var ErrNoPassword = errors.New("absdb: database is encrypted but no password was supplied")

+ var ErrNoRecord = errors.New("absdb: no such record")

+ var ErrNoSuchColumn = errors.New("absdb: no such column")

+ var ErrNoSuchIndex = errors.New("absdb: no such index")

+ var ErrNoSuchTable = errors.New("absdb: no such table")

+ var ErrOutOfSpace = errors.New("absdb: not enough free pages")

+ var ErrPageUnattributed = errors.New("absdb: file holds a page that belongs to no table")

+ var ErrReadOnly = errors.New("absdb: database is open read-only")

+ var ErrRecordSize = errors.New("absdb: record buffer has the wrong size")

+ var ErrRecordWontFit = errors.New("absdb: an existing record would not fit its page after the column change")

+ var ErrRijndaelKeySize = errors.New("absdb: rijndael key must be 16, 24 or 32 bytes")

+ var ErrSchemaTailNotUnderstood = errors.New("absdb: schema stream tail is not understood")

+ var ErrSlotOccupied = errors.New("absdb: record slot is occupied")

+ var ErrSquareKeySize = errors.New("absdb: square key must be 16 bytes")

+ var ErrStringEncoding = errors.New("absdb: string cannot be stored in the column's character set")

+ var ErrTableExists = errors.New("absdb: table already exists")

+ var ErrTableFull = errors.New("absdb: no free record slot in any data page")

+ var ErrTableHasBlobPages = errors.New("absdb: table owns BLOB pages this package cannot free")

+ var ErrTripleDESKeySize = errors.New("absdb: 3TDES key must be 16 or 24 bytes")

+ var ErrTwofishKeySize = errors.New("absdb: twofish key must be 16 or 32 bytes")

+ var ErrUnsupportedCipherMode = errors.New("absdb: unsupported cipher mode")

+ var ErrUnsupportedColumnType = errors.New("absdb: column type has no corpus evidence for CREATE TABLE")

+ var ErrUnsupportedIndexColumn = errors.New("absdb: index column type has no corpus evidence for CREATE INDEX")

+ var ErrValueCount = errors.New("absdb: wrong number of values for the table's columns")

+ var ErrValueRange = errors.New("absdb: value does not fit the column")

+ var ErrValueType = errors.New("absdb: value type does not fit the column")

+ var ErrWriterClosed = errors.New("absdb: writer is closed")

+ func CompactDatabase(srcPath, dstPath string) error

type Column

+ func (c Column) HasDefault() bool

+ func (c Column) NotNull() (notNull, known bool)

+ type CreateDatabaseOptions struct

+ Encrypted bool

+ MaxConnections int

+ PageCountInExtent int

+ PageSize int

type CryptoAlgorithm

+ func (a CryptoAlgorithm) String() string

type File

+ func CreateDatabase(path string, opts CreateDatabaseOptions) (*File, error)

+ func OpenForWrite(path string) (*File, error)

+ func OpenForWriteWithPassword(path, password string) (*File, error)

+ func (db *File) AddColumn(table string, column Column) error

+ func (db *File) CreateIndex(table, index, column string) error

+ func (db *File) CreateTable(name string, columns []Column) error

+ func (db *File) DropColumn(table, column string) error

+ func (db *File) DropIndex(table, index string) error

+ func (db *File) DropTable(name string) error

+ func (db *File) OpenTableWriter() (*TableWriter, error)

+ func (db *File) Table(name string) (*Table, error)

+ func (db *File) Tables() ([]TableInfo, error)

+ func (db *File) Unlock(password string) error

+ func (db *File) Writable() bool

+ type GUID [guidSize]byte

+ func (g GUID) String() string

type IndexReader

+ func (ir *IndexReader) UserIndexes() []IndexInfo

type Page

+ Payload []byte

+ func (p Page) Freed() bool

type Reader

+ func (r *Reader) RecordID() (RecordID, bool)

type Record

+ func (rec Record) GUID(col int) GUID

+ func (rec Record) Int16(col int) int16

+ func (rec Record) Uint16(col int) uint16

+ type RecordID struct

+ PageNo int

+ Slot int

+ type Table struct

+ func (t *Table) Info() TableInfo

+ func (t *Table) Name() string

+ func (t *Table) Open() (*Reader, error)

+ func (t *Table) OpenIndex() (*IndexReader, error)

+ func (t *Table) OpenWriter() (*TableWriter, error)

+ func (t *Table) Schema() (*TableSchema, error)

+ type TableInfo struct

+ ID int

+ InfoPageNo int

+ Name string

+ SchemaPageNo int

+ type TableWriter struct

+ func (w *TableWriter) Close() error

+ func (w *TableWriter) Commit() error

+ func (w *TableWriter) Delete(id RecordID) error

+ func (w *TableWriter) Insert(values []any) (RecordID, error)

+ func (w *TableWriter) Record(id RecordID) (Record, error)

+ func (w *TableWriter) Rollback()

+ func (w *TableWriter) Schema() *TableSchema

+ func (w *TableWriter) Update(id RecordID, values []any) error

+ func (w *TableWriter) UpdateColumn(id RecordID, col int, value any) error

v0.1.0

Mar 28, 2026

Changes in this version

+ const PageTypeBlob

+ const PageTypeData

+ const PageTypeFileHdr

+ const PageTypeIndex

+ const PageTypeSchema

+ const PageTypeSystemDir

+ var ErrBadSchema = errors.New("absdb: malformed schema data")

+ var ErrBlobNotFound = fmt.Errorf("absdb: BLOB data not found")

+ var ErrBlobTrunc = fmt.Errorf("absdb: BLOB data truncated")

+ var ErrCompression = errors.New("absdb: decompression failed")

+ var ErrKeyNotFound = errors.New("absdb: key not found")

+ var ErrNoData = errors.New("absdb: no data pages found")

+ var ErrNoIndex = errors.New("absdb: no index found")

+ var ErrNoMoreRows = errors.New("absdb: no more rows")

+ var ErrNoSchema = errors.New("absdb: no schema page found")

+ var ErrNotABS = errors.New("absdb: not an Absolute Database file")

+ var ErrPageOutOfRange = errors.New("absdb: page number out of range")

+ var ErrTruncated = errors.New("absdb: file is truncated")

+ var ErrUnsupportedCipher = errors.New("absdb: unsupported encryption algorithm")

+ var ErrWrongPassword = errors.New("absdb: incorrect password")

+ var Magic = [16]byte

+ type BTreeEntry struct

+ ItemNo uint16

+ Key []byte

+ PageNo int32

+ func (e BTreeEntry) RecordID() (int32, uint16)

+ type BTreePageHeader struct

+ EntryCount uint16

+ HasKeys bool

+ HasSuffixes bool

+ IsLeaf bool

+ IsRoot bool

+ KeyPrefixSize uint16

+ LeftPageNo int32

+ PagePrefixSize uint16

+ RightPageNo int32

+ type BaseFieldType byte

+ const BftBlob

+ const BftBytes

+ const BftChar

+ const BftClob

+ const BftCurrency

+ const BftDate

+ const BftDateTime

+ const BftDouble

+ const BftExtended

+ const BftInt16

+ const BftInt32

+ const BftInt64

+ const BftInt8

+ const BftLogical

+ const BftSingle

+ const BftTime

+ const BftUint16

+ const BftUint32

+ const BftUint8

+ const BftUnknown

+ const BftVarBytes

+ const BftVarchar

+ const BftWideChar

+ const BftWideClob

+ const BftWideVarchar

+ type BlobRef struct

+ ItemNo uint16

+ PageNo int32

+ func (ref BlobRef) IsNull() bool

+ type Column struct

+ BaseType BaseFieldType

+ FieldType FieldType

+ ID uint32

+ Name string

+ Position int

+ Size uint32

+ func (c Column) IsBLOB() bool

+ type CryptoAlgorithm byte

+ const CryptoBlowfish

+ const CryptoDESSingle

+ const CryptoDESTriple

+ const CryptoRijndael128

+ const CryptoRijndael256

+ const CryptoSquare

+ const CryptoTwofish128

+ const CryptoTwofish256

+ type CryptoHeader struct

+ Algorithm CryptoAlgorithm

+ ControlBlock [controlBlockSize]byte

+ ControlCRC uint32

+ HeaderSize int16

+ Mode byte

+ type DiskPageHeader struct

+ CRC32 uint32

+ CRCType byte

+ CipherType byte

+ HashType byte

+ MACType byte

+ NextPageNo int32

+ ObjectID int32

+ PageType uint16

+ RecItemNo uint16

+ RecPageNo int32

+ State int32

+ type FieldType byte

+ const FieldAutoInc

+ const FieldAutoIncInt16

+ const FieldAutoIncInt32

+ const FieldAutoIncInt64

+ const FieldAutoIncInt8

+ const FieldAutoIncUint16

+ const FieldAutoIncUint32

+ const FieldAutoIncUint8

+ const FieldBLOB

+ const FieldBoolean

+ const FieldByte

+ const FieldBytes

+ const FieldCardinal

+ const FieldChar

+ const FieldCurrency

+ const FieldDate

+ const FieldDateTime

+ const FieldDouble

+ const FieldExtended

+ const FieldFmtMemo

+ const FieldGUID

+ const FieldGraphic

+ const FieldInteger

+ const FieldLargeInt

+ const FieldMemo

+ const FieldShortInt

+ const FieldSingle

+ const FieldSmallInt

+ const FieldString

+ const FieldTime

+ const FieldTimeStamp

+ const FieldUnknown

+ const FieldVarBytes

+ const FieldWideChar

+ const FieldWideMemo

+ const FieldWideString

+ const FieldWord

+ func (ft FieldType) String() string

+ type File struct

+ func Open(path string) (*File, error)

+ func OpenWithPassword(path, password string) (*File, error)

+ func (db *File) Close() error

+ func (db *File) CryptoHeader() *CryptoHeader

+ func (db *File) Encrypted() bool

+ func (db *File) OpenIndex() (*IndexReader, error)

+ func (db *File) OpenTable() (*Reader, error)

+ func (db *File) PageCount() int

+ func (db *File) PageSize() int

+ func (db *File) ReadBlob(ref BlobRef) ([]byte, error)

+ func (db *File) ReadPage(n int) (Page, error)

+ func (db *File) ScanPages() ([]PageSummary, error)

+ func (db *File) Schema() (*TableSchema, error)

+ func (db *File) VerifyPassword(password string) bool

+ func (db *File) Version() float64

+ type IndexInfo struct

+ EntryCount int

+ IsInternal bool

+ KeySize int

+ RootPageNo int

+ type IndexReader struct

+ func (ir *IndexReader) FindByPrimaryKey(key int32) (dataPageNo int32, itemNo uint16, err error)

+ func (ir *IndexReader) FindByStringKey(value string) (dataPageNo int32, itemNo uint16, err error)

+ func (ir *IndexReader) Indexes() []IndexInfo

+ func (ir *IndexReader) PrimaryKeyIndex() (*indexRoot, error)

+ func (ir *IndexReader) ScanIndex(rootPageNo int) ([]BTreeEntry, error)

+ func (ir *IndexReader) SecondaryIndexes() []IndexInfo

+ type Page struct

+ Data []byte

+ Header *DiskPageHeader

+ Number int

+ func (p Page) IsEmpty() bool

+ func (p Page) PageData() []byte

+ type PageSummary struct

+ Empty bool

+ Header *DiskPageHeader

+ Number int

+ type Reader struct

+ func (r *Reader) Err() error

+ func (r *Reader) Next() bool

+ func (r *Reader) Record() Record

+ func (r *Reader) Schema() *TableSchema

+ type Record struct

+ func (rec Record) Blob(col int) ([]byte, error)

+ func (rec Record) BlobRef(col int) BlobRef

+ func (rec Record) Bool(col int) bool

+ func (rec Record) Bytes(col int) []byte

+ func (rec Record) Float(col int) float64

+ func (rec Record) Int(col int) int32

+ func (rec Record) Int64(col int) int64

+ func (rec Record) IsNull(col int) bool

+ func (rec Record) Memo(col int) (string, error)

+ func (rec Record) String(col int) string

+ func (rec Record) Time(col int) time.Time

+ func (rec Record) Uint32(col int) uint32

+ type TableSchema struct

+ Columns []Column

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL