subversion/libsvn_fs_base/bdb/reps-table.h

   1 /* reps-table.h : internal interface to `representations' table
   2  *
   3  * ====================================================================
   4  * Copyright (c) 2000-2004 CollabNet.  All rights reserved.
   5  *
   6  * This software is licensed as described in the file COPYING, which
   7  * you should have received as part of this distribution.  The terms
   8  * are also available at http://subversion.tigris.org/license-1.html.
   9  * If newer versions of this license are posted there, you may use a
  10  * newer version instead, at your option.
  11  *
  12  * This software consists of voluntary contributions made by many
  13  * individuals.  For exact contribution history, see the revision
  14  * history and logs, available at http://subversion.tigris.org/.
  15  * ====================================================================
  16  */
  17
  18 #ifndef SVN_LIBSVN_FS_REPS_TABLE_H
  19 #define SVN_LIBSVN_FS_REPS_TABLE_H
  20
  21 #define APU_WANT_DB
  22 #include <apu_want.h>
  23
  24 #include "svn_io.h"
  25 #include "svn_fs.h"
  26 #include "../fs.h"
  27 #include "../trail.h"
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif /* __cplusplus */
  32
  33 \f
  34 /*** Creating the `representations' table. ***/
  35
  36 /* Open a `representations' table in ENV.  If CREATE is non-zero,
  37    create one if it doesn't exist.  Set *REPS_P to the new table.
  38    Return a Berkeley DB error code.  */
  39 int svn_fs_bdb__open_reps_table(DB **reps_p,
  40                                 DB_ENV *env,
  41                                 svn_boolean_t create);
  42
  43
  44 \f
  45 /*** Storing and retrieving reps.  ***/
  46
  47 /* Set *REP_P to point to the representation for the key KEY in
  48    FS, as part of TRAIL.  Perform all allocations in POOL.
  49
  50    If KEY is not a representation in FS, the error
  51    SVN_ERR_FS_NO_SUCH_REPRESENTATION is returned.  */
  52 svn_error_t *svn_fs_bdb__read_rep(representation_t **rep_p,
  53                                   svn_fs_t *fs,
  54                                   const char *key,
  55                                   trail_t *trail,
  56                                   apr_pool_t *pool);
  57
  58
  59 /* Store REP as the representation for KEY in FS, as part of
  60    TRAIL.  Do any necessary temporary allocation in POOL.  */
  61 svn_error_t *svn_fs_bdb__write_rep(svn_fs_t *fs,
  62                                    const char *key,
  63                                    const representation_t *rep,
  64                                    trail_t *trail,
  65                                    apr_pool_t *pool);
  66
  67
  68 /* Store REP as a new representation in FS, and the new rep's key in
  69    *KEY, as part of trail.  The new key is allocated in POOL.  */
  70 svn_error_t *svn_fs_bdb__write_new_rep(const char **key,
  71                                        svn_fs_t *fs,
  72                                        const representation_t *rep,
  73                                        trail_t *trail,
  74                                        apr_pool_t *pool);
  75
  76 /* Delete representation KEY from FS, as part of TRAIL.
  77    WARNING: This does not ensure that no one references this
  78    representation!  Callers should ensure that themselves.  */
  79 svn_error_t *svn_fs_bdb__delete_rep(svn_fs_t *fs,
  80                                     const char *key,
  81                                     trail_t *trail,
  82                                     apr_pool_t *pool);
  83
  84
  85 #ifdef __cplusplus
  86 }
  87 #endif /* __cplusplus */
  88
  89 #endif /* SVN_LIBSVN_FS_REPS_TABLE_H */