0001 UBFDB.INI(5)
0002 ============
0003 :doctype: manpage
0004
0005
0006 NAME
0007 ----
0008 ubfdb.ini - Enduro/X UBF custom field database configuration file
0009
0010
0011 SYNOPSIS
0012 --------
0013
0014 ---------------------------------------------------------------------
0015 [@ubfdb[/CCTAG]]
0016 resource=DATABASE_DIRECTORY
0017 max_readers=MAX_READERS
0018 map_size=MAP_SIZE
0019 perms=DB_PERMISSIONS
0020 ---------------------------------------------------------------------
0021
0022
0023 DESCRIPTION
0024 -----------
0025 This is optional LMDB database used for custom UBF field storage. Database
0026 must be defined in common-configuration environment. The DB must defined in
0027 order to use following functions: *Bflddbname(3)*, *Bflddbload(3)*,
0028 *Bflddbunload(3)*, *Bflddbdrop(3)*, *Bflddbdel(3)*, *Bflddbadd(3)*,
0029 *Bflddbunlink(3)*.
0030
0031 DATABASE DEFINITION
0032 -------------------
0033 *CCTAG*::
0034 Is optional configuration sub-section. All processes which are willing to
0035 use the specific database shall be configured under this tag. Otherwise
0036 the global tag could be used, that will be visible by all local domain
0037 processes.
0038 *DATABASE_DIRECTORY*::
0039 This is file system directory where UBF database is located.
0040 The directory must exist when application is started. Parameter is *mandatory*.
0041 *DATABASE_DIRECTORY*::
0042 This is file system directory where UBF custom field database is located.
0043 Parameter is *mandatory*, in case if '[@ubfdb]' section is defined.
0044 *MAX_READERS*::
0045 See LMDB documentation for this. Basically this is number of threads or
0046 processes using the database. See LMDB's mdb_env_set_maxreaders()
0047 function description. The
0048 default value set by Enduro/X is *1000*.
0049 *MAP_SIZE*::
0050 Maximum size of the database in bytes. The size must be multiple of OS page
0051 size. See LMDB's mdb_env_set_mapsize() function description. The default
0052 value used by Enduro/X is *512000*. Postifx multiplier can be used for
0053 value in configuration: kK(x1000) mM (x1000'000) gG (x1000'000'000) e.g. 10M.
0054 *DB_PERMISSIONS*::
0055 Octal permissions for map files on file system. The default value is *0664*.
0056
0057 EXAMPLE
0058 -------
0059
0060 Simple configuration:
0061
0062 ---------------------------------------------------------------------
0063 [@ubfdb]
0064 resource=/home/user1/test/db
0065 ---------------------------------------------------------------------
0066
0067 For more unit tests please see 'atmitest/test050_ubfdb' unit test folder ini
0068 files.
0069
0070
0071 BUGS
0072 ----
0073 Report bugs to support@mavimax.com
0074
0075 SEE ALSO
0076 --------
0077 *xadmin(8)* *Bflddbname(3)*, *Bflddbload(3)* *Bflddbunload(3)* *Bflddbdrop(3)*
0078 *Bflddbdel(3)* *Bflddbadd(3)* *Bflddbunlink(3)*
0079
0080 COPYING
0081 -------
0082 (C) Mavimax, Ltd
0083
