lib/libc/db/man/recno.3

   1 .\" Copyright (c) 1990, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)recno.3     8.5 (Berkeley) 8/18/94
  29 .\" $FreeBSD: src/lib/libc/db/man/recno.3,v 1.4.2.2 2001/12/14 18:33:49 ru Exp $
  30 .\" $DragonFly: src/lib/libc/db/man/recno.3,v 1.3 2005/09/19 09:20:37 asmodai Exp $
  31 .\"
  32 .Dd August 18, 1994
  33 .Dt RECNO 3
  34 .Os
  35 .Sh NAME
  36 .Nm recno
  37 .Nd "record number database access method"
  38 .Sh SYNOPSIS
  39 .In sys/types.h
  40 .In db.h
  41 .Sh DESCRIPTION
  42 The routine
  43 .Fn dbopen
  44 is the library interface to database files.
  45 One of the supported file formats is record number files.
  46 The general description of the database access methods is in
  47 .Xr dbopen 3 ,
  48 this manual page describes only the
  49 .Nm
  50 specific information.
  51 .Pp
  52 The record number data structure is either variable or fixed-length
  53 records stored in a flat-file format, accessed by the logical record
  54 number.
  55 The existence of record number five implies the existence of records
  56 one through four, and the deletion of record number one causes
  57 record number five to be renumbered to record number four, as well
  58 as the cursor, if positioned after record number one, to shift down
  59 one record.
  60 .Pp
  61 The
  62 .Nm
  63 access method specific data structure provided to
  64 .Fn dbopen
  65 is defined in the
  66 .Aq Pa db.h
  67 include file as follows:
  68 .Bd -literal
  69 typedef struct {
  70         u_long flags;
  71         u_int cachesize;
  72         u_int psize;
  73         int lorder;
  74         size_t reclen;
  75         u_char bval;
  76         char *bfname;
  77 } RECNOINFO;
  78 .Ed
  79 .Pp
  80 The elements of this structure are defined as follows:
  81 .Bl -tag -width indent
  82 .It Va flags
  83 The flag value is specified by
  84 .Em or Ns 'ing
  85 any of the following values:
  86 .Bl -tag -width indent
  87 .It Dv R_FIXEDLEN
  88 The records are fixed-length, not byte delimited.
  89 The structure element
  90 .Va reclen
  91 specifies the length of the record, and the structure element
  92 .Va bval
  93 is used as the pad character.
  94 Any records, inserted into the database, that are less than
  95 .Va reclen
  96 bytes long are automatically padded.
  97 .It Dv R_NOKEY
  98 In the interface specified by
  99 .Fn dbopen ,
 100 the sequential record retrieval fills in both the caller's key and
 101 data structures.
 102 If the
 103 .Dv R_NOKEY
 104 flag is specified, the
 105 .Em cursor
 106 routines are not required to fill in the key structure.
 107 This permits applications to retrieve records at the end of files without
 108 reading all of the intervening records.
 109 .It Dv R_SNAPSHOT
 110 This flag requires that a snapshot of the file be taken when
 111 .Fn dbopen
 112 is called, instead of permitting any unmodified records to be read from
 113 the original file.
 114 .El
 115 .It Va cachesize
 116 A suggested maximum size, in bytes, of the memory cache.
 117 This value is
 118 .Em only
 119 advisory, and the access method will allocate more memory rather than fail.
 120 If
 121 .Va cachesize
 122 is 0 (no size is specified) a default cache is used.
 123 .It Va psize
 124 The
 125 .Nm
 126 access method stores the in-memory copies of its records
 127 in a btree.
 128 This value is the size (in bytes) of the pages used for nodes in that tree.
 129 If
 130 .Va psize
 131 is 0 (no page size is specified) a page size is chosen based on the
 132 underlying file system I/O block size.
 133 See
 134 .Xr btree 3
 135 for more information.
 136 .It Va lorder
 137 The byte order for integers in the stored database metadata.
 138 The number should represent the order as an integer; for example,
 139 big endian order would be the number 4,321.
 140 If
 141 .Va lorder
 142 is 0 (no order is specified) the current host order is used.
 143 .It Va reclen
 144 The length of a fixed-length record.
 145 .It Va bval
 146 The delimiting byte to be used to mark the end of a record for
 147 variable-length records, and the pad character for fixed-length
 148 records.
 149 If no value is specified, newlines
 150 .Pq Dq \en
 151 are used to mark the end
 152 of variable-length records and fixed-length records are padded with
 153 spaces.
 154 .It Va bfname
 155 The
 156 .Nm
 157 access method stores the in-memory copies of its records
 158 in a btree.
 159 If
 160 .Va bfname
 161 is
 162 .No non\- Ns Dv NULL ,
 163 it specifies the name of the btree file,
 164 as if specified as the file name for a
 165 .Fn dbopen
 166 of a btree file.
 167 .El
 168 .Pp
 169 The data part of the key/data pair used by the
 170 .Nm
 171 access method
 172 is the same as other access methods.
 173 The key is different.
 174 The
 175 .Va data
 176 field of the key should be a pointer to a memory location of type
 177 .Ft recno_t ,
 178 as defined in the
 179 .Aq Pa db.h
 180 include file.
 181 This type is normally the largest unsigned integral type available to
 182 the implementation.
 183 The
 184 .Va size
 185 field of the key should be the size of that type.
 186 .Pp
 187 Because there can be no meta-data associated with the underlying
 188 .Nm
 189 access method files, any changes made to the default values
 190 (e.g. fixed record length or byte separator value) must be explicitly
 191 specified each time the file is opened.
 192 .Pp
 193 In the interface specified by
 194 .Fn dbopen ,
 195 using the
 196 .Va put
 197 interface to create a new record will cause the creation of multiple,
 198 empty records if the record number is more than one greater than the
 199 largest record currently in the database.
 200 .Sh ERRORS
 201 The
 202 .Nm
 203 access method routines may fail and set
 204 .Va errno
 205 for any of the errors specified for the library routine
 206 .Xr dbopen 3
 207 or the following:
 208 .Bl -tag -width Er
 209 .It Bq Er EINVAL
 210 An attempt was made to add a record to a fixed-length database that
 211 was too large to fit.
 212 .El
 213 .Sh SEE ALSO
 214 .Xr btree 3 ,
 215 .Xr dbopen 3 ,
 216 .Xr hash 3 ,
 217 .Xr mpool 3
 218 .Rs
 219 .%T "Document Processing in a Relational Database System"
 220 .%A Michael Stonebraker
 221 .%A Heidi Stettner
 222 .%A Joseph Kalash
 223 .%A Antonin Guttman
 224 .%A Nadene Lynn
 225 .%R "Memorandum No. UCB/ERL M82/32"
 226 .%D May 1982
 227 .Re
 228 .Sh BUGS
 229 Only big and little endian byte order is supported.