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.5 2007/08/18 20:48:47 swildner 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 LIBRARY
  39 .Lb libc
  40 .Sh SYNOPSIS
  41 .In sys/types.h
  42 .In db.h
  43 .Sh DESCRIPTION
  44 The routine
  45 .Fn dbopen
  46 is the library interface to database files.
  47 One of the supported file formats is record number files.
  48 The general description of the database access methods is in
  49 .Xr dbopen 3 ,
  50 this manual page describes only the
  51 .Nm
  52 specific information.
  53 .Pp
  54 The record number data structure is either variable or fixed-length
  55 records stored in a flat-file format, accessed by the logical record
  56 number.
  57 The existence of record number five implies the existence of records
  58 one through four, and the deletion of record number one causes
  59 record number five to be renumbered to record number four, as well
  60 as the cursor, if positioned after record number one, to shift down
  61 one record.
  62 .Pp
  63 The
  64 .Nm
  65 access method specific data structure provided to
  66 .Fn dbopen
  67 is defined in the
  68 .In db.h
  69 include file as follows:
  70 .Bd -literal
  71 typedef struct {
  72         u_long flags;
  73         u_int cachesize;
  74         u_int psize;
  75         int lorder;
  76         size_t reclen;
  77         u_char bval;
  78         char *bfname;
  79 } RECNOINFO;
  80 .Ed
  81 .Pp
  82 The elements of this structure are defined as follows:
  83 .Bl -tag -width indent
  84 .It Va flags
  85 The flag value is specified by
  86 .Em or Ns 'ing
  87 any of the following values:
  88 .Bl -tag -width indent
  89 .It Dv R_FIXEDLEN
  90 The records are fixed-length, not byte delimited.
  91 The structure element
  92 .Va reclen
  93 specifies the length of the record, and the structure element
  94 .Va bval
  95 is used as the pad character.
  96 Any records, inserted into the database, that are less than
  97 .Va reclen
  98 bytes long are automatically padded.
  99 .It Dv R_NOKEY
 100 In the interface specified by
 101 .Fn dbopen ,
 102 the sequential record retrieval fills in both the caller's key and
 103 data structures.
 104 If the
 105 .Dv R_NOKEY
 106 flag is specified, the
 107 .Em cursor
 108 routines are not required to fill in the key structure.
 109 This permits applications to retrieve records at the end of files without
 110 reading all of the intervening records.
 111 .It Dv R_SNAPSHOT
 112 This flag requires that a snapshot of the file be taken when
 113 .Fn dbopen
 114 is called, instead of permitting any unmodified records to be read from
 115 the original file.
 116 .El
 117 .It Va cachesize
 118 A suggested maximum size, in bytes, of the memory cache.
 119 This value is
 120 .Em only
 121 advisory, and the access method will allocate more memory rather than fail.
 122 If
 123 .Va cachesize
 124 is 0 (no size is specified) a default cache is used.
 125 .It Va psize
 126 The
 127 .Nm
 128 access method stores the in-memory copies of its records
 129 in a btree.
 130 This value is the size (in bytes) of the pages used for nodes in that tree.
 131 If
 132 .Va psize
 133 is 0 (no page size is specified) a page size is chosen based on the
 134 underlying file system I/O block size.
 135 See
 136 .Xr btree 3
 137 for more information.
 138 .It Va lorder
 139 The byte order for integers in the stored database metadata.
 140 The number should represent the order as an integer; for example,
 141 big endian order would be the number 4,321.
 142 If
 143 .Va lorder
 144 is 0 (no order is specified) the current host order is used.
 145 .It Va reclen
 146 The length of a fixed-length record.
 147 .It Va bval
 148 The delimiting byte to be used to mark the end of a record for
 149 variable-length records, and the pad character for fixed-length
 150 records.
 151 If no value is specified, newlines
 152 .Pq Dq \en
 153 are used to mark the end
 154 of variable-length records and fixed-length records are padded with
 155 spaces.
 156 .It Va bfname
 157 The
 158 .Nm
 159 access method stores the in-memory copies of its records
 160 in a btree.
 161 If
 162 .Va bfname
 163 is
 164 .No non\- Ns Dv NULL ,
 165 it specifies the name of the btree file,
 166 as if specified as the file name for a
 167 .Fn dbopen
 168 of a btree file.
 169 .El
 170 .Pp
 171 The data part of the key/data pair used by the
 172 .Nm
 173 access method
 174 is the same as other access methods.
 175 The key is different.
 176 The
 177 .Va data
 178 field of the key should be a pointer to a memory location of type
 179 .Ft recno_t ,
 180 as defined in the
 181 .In db.h
 182 include file.
 183 This type is normally the largest unsigned integral type available to
 184 the implementation.
 185 The
 186 .Va size
 187 field of the key should be the size of that type.
 188 .Pp
 189 Because there can be no meta-data associated with the underlying
 190 .Nm
 191 access method files, any changes made to the default values
 192 (e.g. fixed record length or byte separator value) must be explicitly
 193 specified each time the file is opened.
 194 .Pp
 195 In the interface specified by
 196 .Fn dbopen ,
 197 using the
 198 .Va put
 199 interface to create a new record will cause the creation of multiple,
 200 empty records if the record number is more than one greater than the
 201 largest record currently in the database.
 202 .Sh ERRORS
 203 The
 204 .Nm
 205 access method routines may fail and set
 206 .Va errno
 207 for any of the errors specified for the library routine
 208 .Xr dbopen 3
 209 or the following:
 210 .Bl -tag -width Er
 211 .It Bq Er EINVAL
 212 An attempt was made to add a record to a fixed-length database that
 213 was too large to fit.
 214 .El
 215 .Sh SEE ALSO
 216 .Xr btree 3 ,
 217 .Xr dbopen 3 ,
 218 .Xr hash 3 ,
 219 .Xr mpool 3
 220 .Rs
 221 .%T "Document Processing in a Relational Database System"
 222 .%A Michael Stonebraker
 223 .%A Heidi Stettner
 224 .%A Joseph Kalash
 225 .%A Antonin Guttman
 226 .%A Nadene Lynn
 227 .%R "Memorandum No. UCB/ERL M82/32"
 228 .%D May 1982
 229 .Re
 230 .Sh BUGS
 231 Only big and little endian byte order is supported.