/usr/include/ncbi-vdb/vdb/table.h is in libncbi-vdb-dev 2.8.1+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 | /*===========================================================================
*
* PUBLIC DOMAIN NOTICE
* National Center for Biotechnology Information
*
* This software/database is a "United States Government Work" under the
* terms of the United States Copyright Act. It was written as part of
* the author's official duties as a United States Government employee and
* thus cannot be copyrighted. This software/database is freely available
* to the public for use. The National Library of Medicine and the U.S.
* Government have not placed any restriction on its use or reproduction.
*
* Although all reasonable efforts have been taken to ensure the accuracy
* and reliability of the software and data, the NLM and the U.S.
* Government do not and cannot warrant the performance or results that
* may be obtained by using this software or data. The NLM and the U.S.
* Government disclaim all warranties, express or implied, including
* warranties of performance, merchantability or fitness for any particular
* purpose.
*
* Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
*/
#ifndef _h_vdb_table_
#define _h_vdb_table_
#ifndef _h_vdb_extern_
#include <vdb/extern.h>
#endif
#ifndef _h_kfs_directory_
#include <kfs/directory.h>
#endif
#ifndef _h_kdb_column_
#include <kdb/column.h>
#endif
#ifndef _h_kdb_index_
#include <kdb/index.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*--------------------------------------------------------------------------
* forwards
*/
struct VSchema;
struct KMetadata;
struct KNamelist;
struct VDatabase;
struct VDBManager;
/*--------------------------------------------------------------------------
* VTable
* a collection of columns indexed by row id, metadata, indices
*/
typedef struct VTable VTable;
/* AddRef
* Release
* all objects are reference counted
* NULL references are ignored
*/
VDB_EXTERN rc_t CC VTableAddRef ( const VTable *self );
VDB_EXTERN rc_t CC VTableRelease ( const VTable *self );
/* CreateTable
* create a new or open an existing table using manager
*
* "tbl" [ OUT ] - return parameter for newly opened table
*
* "schema" [ IN ] - schema object containg table
* declaration to be used in creating tbl.
*
* "typespec" [ IN ] - type and optionally version of table schema,
* e.g. 'MY_NAMESPACE:MyTable' or 'MY_NAMESPACE:MyTable#1.1'
*
* "cmode" [ IN ] - creation mode
*
* "path" [ IN ] - NUL terminated string in
* wd-native character set giving path to table
*/
VDB_EXTERN rc_t CC VDBManagerCreateTable ( struct VDBManager *self, VTable **tbl,
struct VSchema const *schema, const char *typespec,
KCreateMode cmode, const char *path, ... );
VDB_EXTERN rc_t CC VDBManagerVCreateTable ( struct VDBManager *self, VTable **tbl,
struct VSchema const *schema, const char *typespec,
KCreateMode cmode, const char *path, va_list args );
/* CreateTable
* create a new or open an existing table under database
*
* "tbl" [ OUT ] - return parameter for newly opened table
*
* "member" [ IN ] - name of table member template under database
* the named member is a table template rather than a named table.
*
* "cmode" [ IN ] - creation mode
*
* "cmode_mask" [ IN ] - if a bit of "cmode_mask" is set (1) then
* the corresponding bit of "cmode" is used for the table,
* otherwise (0) the corresponding bit is taken from db and "cmode"'s
* bit is ignored.
* the mask for setting mode (kcmOpen, kcmInit, kcmCreate) is at least
* one bit set in the mask kcmValueMask.
*
* "name" [ IN ] - NUL terminated string in
* db-native character set giving actual table name
*/
/*VDB_EXTERN rc_t CC VDatabaseCreateTableDefault ( struct VDatabase *self, VTable **tbl,
const char *member, const char *name, ... );
VDB_EXTERN rc_t CC VDatabaseVCreateTableDefault ( VDatabase *self, VTable **tbl,
const char *member, const char *name, va_list args )
*/
VDB_EXTERN rc_t CC VDatabaseCreateTableByMask ( struct VDatabase *self, VTable **tbl,
const char *member, KCreateMode cmode, KCreateMode cmode_mask, const char *name, ... );
VDB_EXTERN rc_t CC VDatabaseVCreateTableByMask ( struct VDatabase *self, VTable **tbl,
const char *member, KCreateMode cmode, KCreateMode cmode_mask, const char *name, va_list args );
/* the following function is DEPRECATED, it's left for backward compatibility only */
VDB_EXTERN rc_t CC VDatabaseCreateTable ( struct VDatabase *self, VTable **tbl,
const char *member, KCreateMode cmode, const char *name, ... );
/* the following function is DEPRECATED, it's left for backward compatibility only */
VDB_EXTERN rc_t CC VDatabaseVCreateTable ( struct VDatabase *self, VTable **tbl,
const char *member, KCreateMode cmode, const char *name, va_list args );
/* OpenTableRead
* open a table for read using manager
* OpenTableUpdate
* open a table for read/write using manager
*
* "tbl" [ OUT ] - return parameter for newly opened table
*
* "schema" [ IN, NULL OKAY ] - optional schema object with
* latest versions of table schema.
*
* "path" [ IN ] - NUL terminated string in
* wd-native character set giving path to table
*/
VDB_EXTERN rc_t CC VDBManagerOpenTableRead ( struct VDBManager const *self,
const VTable **tbl, struct VSchema const *schema,
const char *path, ... );
VDB_EXTERN rc_t CC VDBManagerVOpenTableRead ( struct VDBManager const *self,
const VTable **tbl, struct VSchema const *schema,
const char *path, va_list args );
VDB_EXTERN rc_t CC VDBManagerOpenTableUpdate ( struct VDBManager *self,
VTable **tbl, struct VSchema const *schema,
const char *path, ... );
VDB_EXTERN rc_t CC VDBManagerVOpenTableUpdate ( struct VDBManager *self,
VTable **tbl, struct VSchema const *schema,
const char *path, va_list args );
/* OpenTableRead
* open a table for read under database
* OpenTableUpdate
* open or create a table for read/write under database
*
* "tbl" [ OUT ] - return parameter for newly opened table
*
* "name" [ IN ] - NUL terminated string in
* db-native character set giving name of table member
*/
VDB_EXTERN rc_t CC VDatabaseOpenTableRead ( struct VDatabase const *self,
const VTable **tbl, const char *name, ... );
VDB_EXTERN rc_t CC VDatabaseVOpenTableRead ( struct VDatabase const *self,
const VTable **tbl, const char *name, va_list args );
VDB_EXTERN rc_t CC VDatabaseOpenTableUpdate ( struct VDatabase *self,
VTable **tbl, const char *name, ... );
VDB_EXTERN rc_t CC VDatabaseVOpenTableUpdate ( struct VDatabase *self,
VTable **tbl, const char *name, va_list args );
/* Typespec
* retrieve table typespec
*
* AVAILABILITY: version 2.1
*
* "ts_buff" [ IN ] and "ts_size" [ IN ] - buffer for return of NUL-terminated
* table typespec, e.g. 'NCBI:tbl:abc #1.1'
*/
VDB_EXTERN rc_t CC VTableTypespec ( const VTable *self,
char *ts_buff, size_t ts_size );
/* Locked
* returns true if locked
*/
VDB_EXTERN bool CC VTableLocked ( const VTable *self );
/* Writable
* returns 0 if object is writable
* or a reason why if not
*
* "type" [ IN ] - a KDBPathType
* valid values are kptIndex and kptColumn
*
* "path" [ IN ] - NUL terminated path
*/
VDB_EXTERN rc_t CC VTableWritable ( const VTable *self, uint32_t type,
const char * name, ... );
VDB_EXTERN rc_t CC VTableVWritable ( const VTable *self, uint32_t type,
const char * name, va_list args );
/* Lock
* apply lock
*
* if object is already locked, the operation is idempotent
* and returns an rc state of rcLocked
*
* "type" [ IN ] - a KDBPathType
* valid values are kptIndex and kptColumn
*
* "path" [ IN ] - NUL terminated path
*/
VDB_EXTERN rc_t CC VTableLock ( VTable *self, uint32_t type,
const char * name, ... );
VDB_EXTERN rc_t CC VTableVLock ( VTable *self, uint32_t type,
const char * name, va_list args );
/* Unlock
* remove lock
*
* if object is already unlocked, the operation is idempotent
* and returns an rc state of rcUnlocked
*
* "type" [ IN ] - a KDBPathType
* valid values are kptIndex and kptColumn
*
* "path" [ IN ] - NUL terminated path
*/
VDB_EXTERN rc_t CC VTableUnlock ( VTable *self, uint32_t type,
const char * name, ... );
VDB_EXTERN rc_t CC VTableVUnlock ( VTable *self, uint32_t type,
const char * name, va_list args );
/* OpenMetadataRead
* OpenMetadataUpdate
* opens metadata file
*
* "meta" [ OUT ] - return parameter for metadata
*/
VDB_EXTERN rc_t CC VTableOpenMetadataRead ( const VTable *self, struct KMetadata const **meta );
VDB_EXTERN rc_t CC VTableOpenMetadataUpdate ( VTable *self, struct KMetadata **meta );
/* ColumnCreateParams
* sets the creation parameters for physical columns
*
* "cmode" [ IN ] - creation mode
*
* "checksum" [ IN ] - the type of checksum information to
* apply when writing blobs
*
* "pgsize" [ IN, DEFAULT ZERO ] - size of internal column "pages"
* the default value is indicated by 0 ( zero ).
* NB - CURRENTLY THE ONLY SUPPORTED PAGE SIZE IS 1 ( ONE ) BYTE.
*/
VDB_EXTERN rc_t CC VTableColumnCreateParams ( VTable *self,
KCreateMode cmode, KChecksum checksum, size_t pgsize );
/* CreateIndex
* VCreateIndex
* create a new or open an existing index
*
* "idx" [ OUT ] - return parameter for newly opened index
*
* "type" [ IN ] - type of index to create
*
* "cmode" [ IN ] - creation mode
*
* "name" [ IN ] - NUL terminated string in UTF-8 giving simple name of idx
*/
VDB_EXTERN rc_t CC VTableCreateIndex ( VTable *self, KIndex **idx,
KIdxType type, KCreateMode cmode, const char *name, ... );
VDB_EXTERN rc_t CC VTableVCreateIndex ( VTable *self, KIndex **idx,
KIdxType type, KCreateMode cmode, const char *name, va_list args );
/* OpenIndexRead
* VOpenIndexRead
* open an index for read
*
* "idx" [ OUT ] - return parameter for newly opened index
*
* "name" [ IN ] - NUL terminated string in UTF-8 giving simple name of idx
*/
VDB_EXTERN rc_t CC VTableOpenIndexRead ( const VTable *self,
const KIndex **idx, const char *name, ... );
VDB_EXTERN rc_t CC VTableVOpenIndexRead ( const VTable *self,
const KIndex **idx, const char *name, va_list args );
/* OpenIndexUpdate
* VOpenIndexUpdate
* open an index for read/write
*
* "idx" [ OUT ] - return parameter for newly opened index
*
* "name" [ IN ] - NUL terminated string in UTF-8 giving simple name of idx
*/
VDB_EXTERN rc_t CC VTableOpenIndexUpdate ( VTable *self,
KIndex **idx, const char *name, ... );
VDB_EXTERN rc_t CC VTableVOpenIndexUpdate ( VTable *self,
KIndex **idx, const char *name, va_list args );
/* ListColumns
* list readable or writable column names
*
* "names" [ OUT ] - return parameter for namelist
*
* availability: v2.1
*/
VDB_EXTERN rc_t CC VTableListReadableColumns ( const VTable *self, struct KNamelist **names );
VDB_EXTERN rc_t CC VTableListWritableColumns ( VTable *self, struct KNamelist **names );
/* ListCol
* alias for VTableListReadableColumns
*
* availability: v2.0
*/
VDB_EXTERN rc_t CC VTableListCol ( const VTable *self, struct KNamelist **names );
/* ListDatatypes
* returns list of typedecls for named column
*
* "col" [ IN ] - column name
*
* "dflt_idx" [ OUT, NULL OKAY ] - returns the zero-based index
* into "typedecls" of the default datatype for the named column
*
* "typedecls" [ OUT ] - list of datatypes available for named column
*
* availability: v2.1
*/
VDB_EXTERN rc_t CC VTableListReadableDatatypes ( const VTable *self, const char *col,
uint32_t *dflt_idx, struct KNamelist **typedecls );
VDB_EXTERN rc_t CC VTableListWritableDatatypes ( VTable *self,
const char *col, struct KNamelist **typedecls );
/* ColumnDatatypes
* alias for VTableListReadableDatatypes
*
* availability: v2.0
*/
VDB_EXTERN rc_t CC VTableColumnDatatypes ( const VTable *self, const char *col,
uint32_t *dflt_idx, struct KNamelist **typedecls );
/* Reindex
* optimize column indices
*/
VDB_EXTERN rc_t CC VTableReindex ( VTable *self );
/* OpenManager
* duplicate reference to manager
* NB - returned reference must be released
*/
VDB_EXTERN rc_t CC VTableOpenManagerRead ( const VTable *self, struct VDBManager const **mgr );
VDB_EXTERN rc_t CC VTableOpenManagerUpdate ( VTable *self, struct VDBManager **mgr );
/* OpenParent
* duplicate reference to parent database
* NB - returned reference must be released
*/
VDB_EXTERN rc_t CC VTableOpenParentRead ( const VTable *self, struct VDatabase const **db );
VDB_EXTERN rc_t CC VTableOpenParentUpdate ( VTable *self, struct VDatabase **db );
/* OpenSchema
* duplicate reference to table schema
* NB - returned reference must be released
*/
VDB_EXTERN rc_t CC VTableOpenSchema ( const VTable *self, struct VSchema const **schema );
/* GetUserData
* SetUserData
* store/retrieve an opaque pointer to user data
*
* "data" [ OUT ] - return parameter for getting data
* "data" [ IN ] - parameter for setting data
*
* "destroy" [ IN, NULL OKAY ] - optional destructor param
* invoked from destructor of "self"
*/
VDB_EXTERN rc_t CC VTableGetUserData ( const VTable *self, void **data );
VDB_EXTERN rc_t CC VTableSetUserData ( const VTable *self,
void *data, void ( CC * destroy ) ( void *data ) );
/* IsEmpty
* check if the table is empty
*/
VDB_EXTERN rc_t CC VTableIsEmpty( const VTable *self, bool * empty );
#ifdef __cplusplus
}
#endif
#endif /* _h_vdb_table_ */
|