ObjectStore C++ Advanced API User Guide
Index
- implementing for os_Dumper_specialization 302
A
- add_index()
- os_collection, defined by 140
- allow_duplicates
- os_collection, defined by 96
- allow_nulls
- os_collection, defined by 96
- application schemas
- setting with set_application_schema_path() 429
- applications
- multithreaded 55
- associative access
- defined 126
- attributes, of MOP class 189
- augment_classes_to_be_recycled()
- os_schema_evolution, defined by 351
- augment_classes_to_be_removed()
- os_schema_evolution, defined by 345
- augment_post_evol_transformers()
- os_schema_evolution, defined by 351, 359
- augment_subtype_selectors()
- os_schema_evolution, defined by 366, 372
- automatic retries 35
B
- be_an_array
- os_collection, defined by 96
- break_link()
- os_backptr, defined by 152, 156
- B-tree
- as ordered index 144
C
- cache files
- deleting unused with cmgr_remove_file() 418
- Cache Manager
- getting status with cmgr_stat() 417
- shutting down with cmgr_shutdown() 419
- change_behavior()
- os_Collection, defined by 98
- change_rep()
- os_collection, defined by 101
- checkpoint()
- os_transaction, defined by 44
- checkpoint/refresh for transactions 43
- chgrp()
- changing database group names 420
- chmod()
- changing database permissions 420
- chown()
- changing database owner 420
- class, system-supplied
- os_pvar 2
- client name
- getting with get_client_name() 416
- setting with set_client_name() 416
- client thread
- killing with svr_client_kill() 414
- clients
- multithreaded 50
- close_all_server_connections()
- closing all Server connections 416
- os_dbutil, defined by 416
- close_server_connection()
- closing Server connection 416
- os_dbutil, defined by 416
- clustering
- and locking 32
- cmgr_remove_file()
- deleting unused cache and commseg files 418
- cmgr_shutdown()
- shutting down Cache Manager 419
- cmgr_stat()
- getting Cache Manager status 417
- collections
- changing associated representation policy 101
- changing behavior 98
- consolidating duplicates 91
- defined 63
- index 140
- index-only 109
- loading phase 95
- range 77
- recursive queries in 82
- representation 100
- collocation ambiguities 376
- commseg files
- deleting unused with cmgr_remove_file() 418
- compact()
- objectstore, defined by 175
- compact.hh header file 178
- compaction
- need for 174
- compactor
- compact.hh header file 178
- limitations 181
- utility 183
- compare_schemas()
- comparing schemas 429
- concurrency control
- multiversion 37
- constructor
- implementing for os_Fixup_dumper 306
- implementing for os_Type_fixup_info 316
- implementing for os_Type_info 308
- copy_classes()
- os_mop, defined by 199
- copy_database()
- copying databases 421
- create function for MOP class 190
- create()
- implementing for os_Type_loader 311
- os_coll_query, defined by 136
- os_index_path, defined by 65
- create_exists()
- os_coll_query, defined by 136
- create_pick()
- os_coll_query, defined by 136
- creating object clusters 7
- cursors
- restricted 80
- customization
- when required for dumping and loading 287
- customizing collection representation 100
- customizing loads 294
D
- data
- implementing for os_Type_info 307
- data transfer 8
- databases
- changing group names with chgrp() 420
- changing owner with chown() 420
- changing permissions with chmod() 420
- copying with copy_database() 421
- finding size with ossize() 426
- moving with rename() 425
- removing links with remove() 424
- deadlock
- and retries 35
- victim 35
- destroy()
- os_coll_query, defined by 137
- os_index_path, defined by 65
- dictionaries
- lookup 80, 88
- directories
- creating rawfs directories with mkdir() 422
- listing rawfs directory contents with list_directory() 425
- moving with rename() 425
- removing rawfs directories with rmdir() 424
- discriminant functions 28
- disk_free()
- getting rawfs disk space information 407
- dont_maintain_size
- os_dictionary, defined by 97
- drop_index()
- os_collection, defined by 142
- dump/load facility
- creation stages 289
- customization 287
- dumped ASCII 285
- fixup-dump mode 290
- object-dump mode 290
- ostore/dumpload 288
- plan mode 290
- dump_info()
- implementing for os_Fixup_dumper 304
- dumped ASCII
- dump/load facility 285
- duplicate()
- implementing for os_Fixup_dumper 306
- dynamic transactions
- scoping 53
- dynamic type creation 187
E
- err_coll_duplicates exception 99
- err_coll_empty exception 86, 88
- err_coll_illegal_arg exception 101
- err_coll_illegal_cursor exception 86
- err_coll_not_singleton exception 86
- err_coll_not_supported exception 86, 87
- err_coll_null_cursor exception 86
- err_coll_nulls exception 99
- err_coll_out_of_range exception 86
- err_deadlock exception 36
- err_illegal_arg exception 99
- err_mop_illegal_cast exception 210
- err_no_such_index exception 142
- err_opened_read_only exception 38
- err_reference_not_found exception 23
- err_schema_evolution exception 344
- err_se_illegal_pointer exception
- child exception of 375
- evolve()
- os_schema_evolution, defined by 202, 347
- exists()
- os_Collection, defined by 131
- expand_global()
- expanding file names 422
F
- fetch policy
- granularity of data transfer 8
- file names
- expanding with expand_global() 422
- find_base_class()
- os_class_type, defined by 356
- find_member()
- os_class_type, defined by 354, 358
- find_type()
- os_mop, defined by 200
- fixup form 294
- fixup()
- implementing for os_Type_fixup_loader 321
- implementing for os_Type_loader 314
- fixup_data
- implementing for os_Type_fixup_info 316
- fixup-dumper class 292
G
- get function for MOP class 190
- get()
- implementing for os_Type_fixup_loader 322
- implementing for os_Type_loader 315
- get_class()
- os_base_class, defined by 356
- get_client_name()
- getting client name 416
- get_evolved_address()
- os_schema_evolution, defined by 375
- get_for_update()
- os_database_schema, defined by 202
- get_kind()
- os_type, defined by 207
- get_path_to_member()
- os_schema_evolution, defined by 375, 378
- get_sector_size()
- determining sector size 413
- get_transient_schema()
- os_mop, defined by 202
- get_type()
- os_member_variable, defined by 356
- os_typed_pointer_void, defined by 354, 358
- get_unevolved_object()
- os_schema_evolution, defined by 353, 358, 370
- global mutex
- thread safety 51
- global transactions
- See transactions
- globally scoped transactions 53
H
- has_index()
- os_collection, defined by 142
- hash functions
- iteration order 92
- header files
- compaction 178
I
- illegal ObjectStore reference handlers 339
- illegal ObjectStore references 339
- illegal pointer handlers 339, 373, 378
- illegal pointers
- detecting 338
- in schema evolution 373
- index maintenance
- and member functions 72, 158
- pointer-valued members 152
- index paths 65
- indexes
- adding 140
- key 140
- optimizing queries 140
- ordered 144
- and performance 141
- removing 142
- testing for presence of 142
- unordered 144
- install()
- os_database_schema, defined by 202
- instance
- defining and registering for os_Planning_action 298
- defining and registering for os_Type_fixup_loader 322
- defining and registering for os_Type_loader 315
- instance initialization 338
- instance migration 337
- instance reclassification 340, 366, 368, 386
- instance transformation 342, 350, 357
- is_open_mvcc()
- os_database, defined by 39
- iteration
- controlling order 92
L
- lexical transactions
- and local scoping 53
- list_directory()
- listing directory contents 425
- load
- customizing 294
- load()
- implementing for os_Type_fixup_loader 319
- implementing for os_Type_loader 310
- locally scoped transactions 53
- lock_segment_read 32
- lock_segment_write 32
- locking
- granularity 32
- reducing wait time 32
- and transaction length 32
- logging
- redo 41
- undo 41
M
- macro arguments
- entering correctly 153
- macro, system-supplied
- os_index() 153
- os_indexable_body() 152
- os_indexable_member() 152
- OS_INITIALIZE_CHAINED_LIST_REP() 102
- OS_INSTANTIATE_CHAINED_LIST_REP() 102
- OS_MARK_CHAINED_LIST_REP() 102
- maintain_cursors
- os_collection, defined by 75, 82, 96
- maintain_key_order
- os_Dictionary, defined by 97
- make_link()
- os_backptr, defined by 152, 156
- setting links in the rawfs 423
- mapaside
- thread safety 51
- Max Data Propagation Per Propagate Server parameter 42
- Max Data Propagation Threshold Server parameter 42
- max_retries
- os_transaction, defined by 35
- memcpy()
- use with persistent references 12
- metaobject protocol
- defined 187
- metatypes
- defined 187
- hierarchy 204
- mkdir()
- creating rawfs directories 422
- MOP
- See metaobject protocol
- multithreaded applications
- models for 55
- multithreaded clients 50
- multiversion concurrency control
- implementation 39
- and multiple databases 38
- and serializability 38
- snapshots 37
- and the transaction log 39
- MVCC
- See multiversion concurrency control
N
- nested transactions 34
O
- object clusters
- creating 7
- object form 294
- object-dumper class 292
- objects
- unspecified 193
- objectstore, the class
- compact() 175
- release_persistent_addresses() 26
- retain_persistent_addresses() 26
- obsolete index handlers 340, 381
- obsolete indexes 339, 381
- obsolete queries 339, 381
- obsolete query handlers 340, 381
- only()
- os_Collection, defined by 86
- open_mvcc()
- os_database, defined by 38
- operator ()()
- implementing for os_Dumper_specialization 299
- implementing for os_Planning_action
- using deep approach 297
- using shallow approach 296
- implementing for os_Type_fixup_loader 318
- implementing for os_Type_loader 309
- operator void*()
- os_typed_pointer_void, defined by 353
- operators
- type-safe conversion 209
- optimizing transactions 53
- ordered
- os_index_path, defined by 144
- os_backptr 69
- os_backptr, the class 150
- break_link() 152, 156
- make_link() 152, 156
- os_base_class, the class
- get_class() 356
- os_bound_query, the class 138
- os_chained_list, the class 102
- os_class_type, the class
- find_base_class() 356
- find_member() 354, 358
- os_coll_query, the class
- create() 136
- create_exists() 136
- create_pick() 136
- destroy() 137
- os_coll_range, the class 77
- os_Collection, the class
- change_behavior() 98
- exists() 131
- only() 86
- query() 127
- query_pick() 130
- retrieve() 86
- retrieve_first() 86
- retrieve_last() 87
- os_collection, the class
- add_index() 140
- allow_duplicates 96
- allow_nulls 96
- be_an_array 96
- change_rep() 101
- drop_index() 142
- has_index() 142
- maintain_cursors 75, 82, 96
- pick_from_empty_returns_null 86, 88, 96, 97
- size_estimate() 110
- size_is_maintained() 110
- update_size() 110
- verify 99
- os_cursor, the class
- safe 75, 83
- os_database, the class
- is_open_mvcc() 39
- open_mvcc() 38
- os_database_schema, the class
- get_for_update() 202
- install() 202
- os_Database_table
- find_reference() 326
- get() 324
- insert() 324
- is_ignored() 326
- os_dbutil, the class
- close_all_server_connections() 416
- close_server_connection() 416
- svr_ping() 414
- os_Dictionary, the class
- maintain_key_order 97
- signal_dup_keys 97
- os_dictionary, the class
- dont_maintain_size 97
- os_Dumper_reference
- get_database() 329
- get_database_number() 329
- get_offset() 330
- get_segment() 329
- get_segment_number() 330
- is_valid() 330
- operator 329
- operator !() 329
- operator !=() 328
- operator =() 327
- operator ==() 328
- operator >() 328
- operator >=() 329
- operator void*() 327
- os_Dumper_reference() 327
- resolve() 328
- os_Dumper_specialization
- specialization 299
- os_dyn_bag, the class 105
- os_dyn_hash, the class 107
- os_fetch() 354, 358
- os_fetch_address() 356
- os_fetch_page fetch policy 8
- when to use 9
- os_fetch_segment fetch policy 8
- when to use 9
- os_fetch_stream fetch policy 8
- when to use 9
- os_Fixup_dumper
- ~os_Fixup() 333
- get_number_elements() 333
- get_object_to_fix() 333
- get_type() 333
- os_Fixup_dumper() 333
- specialization 304
- os_free_blocks, the class
- managing servers 407
- os_index(), the macro 153
- os_index_key(), the macro 92
- os_index_path, the class 65
- create() 65
- destroy() 65
- ordered 144
- os_indexable_body(), the macro 152
- os_indexable_member(), the macro 152
- OS_INITIALIZE_CHAINED_LIST_REP(), the macro 102
- OS_INSTANTIATE_CHAINED_LIST_REP(), the macro 102
- os_ixonly, the class 109
- os_ixonly_bc, the class 109
- os_keyword_arg, the class 138
- os_keyword_arg_list, the class 138
- OS_MARK_CHAINED_LIST_REP(), the macro 102
- OS_MARK_QUERY_FUNCTION(), the macro 69
- os_member_variable, the class
- get_type() 356
- os_mop, the class
- copy_classes() 199
- find_type() 200
- get_transient_schema() 202
- os_ordered_ptr_hash, the class 112
- os_Planning_action
- specialization 295
- os_ptr_bag, the class 116
- os_pvar, the class 2
- os_query_function(), the macro 69
- os_query_function_body(), the macro 69
- os_Reference_protected, the class 23
- os_Reference_protected_local, the class 23
- os_schema_evolution, the class
- augment_classes_to_be_recycled() 351
- augment_classes_to_be_removed() 345
- augment_post_evol_transformers() 351, 359
- augment_subtype_selectors() 366, 372
- evolve() 202, 347
- get_evolved_address() 375
- get_path_to_member() 375, 378
- get_unevolved_object() 353, 358, 370
- path_name() 375, 379
- set_illegal_pointer_handler() 373, 375, 379
- set_local_references_are_db_relative() 346
- set_obsolete_index_handler() 381
- set_obsolete_query_handler() 381
- set_task_list_file_name() 383
- task_list() 382
- os_store() 355
- os_transaction, the class
- checkpoint() 44
- max_retries 35
- os_transformer_binding, the class
- example 359
- os_type, the class
- get_kind() 207
- os_Type_fixup_info
- specialization 316
- os_Type_fixup_loader
- specialization 318
- os_Type_info
- get_original_location() 331
- get_replacing_database() 332
- get_replacing_location() 331
- get_replacing_segment() 332
- get_type() 332
- os_Type_info() 331
- set_replacing_location() 331
- specialization 307
- os_Type_loader
- specialization 309
- os_typed_pointer_void, the class
- get_type() 354, 358
- operator void*() 353
- os_vdyn_bag, the class 118
- oscompact utility 183
- ossize()
- finding database size 426
- <ostore/compact.hh> header file 178
- <ostore/mop.hh> header file 356
- osverifydb()
- verifying pointers and references 427
P
- path expressions 65
- path string 65
- path_name()
- os_schema_evolution, defined by 375, 379
- paths 65
- persistence
- across transaction boundary 26
- persistent delete 33
- persistent new 33
- pick_from_empty_returns_null
- os_collection, defined by 86, 88, 96, 97
- planner classes 291
- pointers
- validity across transaction boundary 26
- verifying with osverifydb() 427
- propagation
- Max Data Propagation Per Propagate Server parameter 42
- Max Data Propagation Threshold Server parameter 42
- Propagation Sleep Time Server parameter 42
- transaction log 41
- Propagation Sleep Time Server parameter 42
- protected references
- overhead 23
- pvars 2
Q
- queries
- bound 138
- existential 131
- nested 132
- nested existential 134
- performance with index 141
- preanalyzed 136
- purpose 126
- range 145
- range, ordered index 144
- single-element 130
- query optimization
- adding index 140
- defined 126
- query string 128
- query()
- os_Collection, defined by 127
- query_pick()
- os_Collection, defined by 130
R
- random access 9
- range queries 145
- rank functions
- possible values returned 92
- rawfs
- changing all rawfs hosts with rehost_all_links() 421
- changing host with rehost_link() 421
- removing links with remove() 424
- setting links with make_link() 423
- testing pathname with stat() 425
- rawfs disk space
- getting information with disk_free() 407
- reclassification functions 340, 366
- recycling 343
- references
- overhead of protected 23
- to migrated instances 339
- verifying with osverifydb() 427
- referent type parameter 12, 15
- rehost_all_links()
- changing all rawfs hosts 421
- rehost_link()
- changing rawfs host 421
- release_persistent_addresses()
- objectstore, defined by 26
- remove()
- removing database or rawfs links 424
- rename()
- moving directories and databases 425
- retain_persistent_addresses()
- objectstore, defined by 26
- retries, transactions 35
- retrieve()
- os_Collection, defined by 86
- retrieve_first()
- os_Collection, defined by 86
- retrieve_last()
- os_Collection, defined by 87
- rmdir()
- removing rawfs directories 424
- root object 294
S
- safe
- os_cursor, defined by 75, 83
- schema access, programmatic
- const 191
- initiating read access 191
- initiating type creation 191, 199
- MOP 187
- pointers compared to references 193
- type-safe conversion operators
- os_member 228
- os_member_variable 231
- os_pointer_type 242
- os_type 209
- schema evolution
- accessing unevolved objects 353
- assignment compatibility 347
- categories of 384
- class creation 384
- class deletion 385, 403
- collocation ambiguities 376
- data member redefinition
- adding data members 388
- changes not requiring evolution 395
- changing name 385
- changing order 394
- changing value type 390
- deleting data members 389
- deleted subobjects 376
- detecting illegal pointers 338
- illegal ObjectStore reference 339
- illegal ObjectStore reference handler 339
- illegal pointer handler 339, 373, 378
- illegal pointers
- collocation ambiguities 376
- inheritance redefinition
- adding base classes 398
- removing base classes 400
- schema changes that represent 385
- virtual and nonvirtual 401
- initiating 344, 347
- instance initialization 338, 384
- instance migration 337
- instance reclassification 340, 366, 368, 386, 404
- instance transformation 342, 350, 357
- member function redefinition 385, 396
- moving data members from base type to derived type 368
- obsolete index 339, 381
- obsolete index handler 340, 381
- obsolete query 339, 381
- obsolete query handler 340, 381
- phases of 337
- reclassification function 340, 366
- recycling 343
- schema modification 337
- subobjects deleted 376
- task lists 340, 382
- transformer functions 342, 350, 357
- using MOP 202
- schema modification 337
- schemas
- See also schema access
- See also transient schemas
- comparing with compare_schemas() 429
- consistency requirements 193
- installation
- using MOP 202
- modification 337
- sector size
- determining with get_sector_size() 413
- sequential access 9
- serializability 38
- Server parameters
- Max Data Propagation Per Propagate 42
- Max Data Propagation Threshold 42
- Propagation Sleep Time 42
- Servers
- closing a connection with close_server_connection() 416
- closing all connections with close_all_server_connections() 416
- determining whether a Server is running with svr_ping() 414
- getting information with svr_stat() 407
- shutting down with svr_shutdown() 415
- set function for MOP class 190
- set_application_schema_path()
- setting application schema 429
- set_client_name()
- setting client name 416
- set_illegal_pointer_handler()
- os_schema_evolution, defined by 373, 375, 379
- set_local_references_are_db_relative()
- os_schema_evolution, defined by 346
- set_lock_whole_segment()
- os_segment, defined by 32
- set_obsolete_index_handler()
- os_schema_evolution, defined by 381
- set_obsolete_query_handler()
- os_schema_evolution, defined by 381
- set_task_list_file_name()
- os_schema_evolution, defined by 383
- signal_dup_keys
- os_Dictionary, defined by 97
- size_estimate()
- os_collection, defined by 110
- size_is_maintained()
- os_collection, defined by 110
- stat()
- testing pathname 425
- svr_checkpoint()
- moving data out of transaction log 415
- svr_client_kill()
- killing a client thread 414
- svr_ping()
- determining whether a Server is running 414
- os_dbutil, defined by 414
- svr_shutdown()
- shutting down the Server 415
- svr_stat()
- getting Server information 407
T
- task lists 340, 382
- task_list()
- os_schema_evolution, defined by 382
- thread safety
- mutex lock 50
- using mapaside 51
- threads
- optimizing transactions 53
- traffic optimization 8
- transaction log
- moving data out of with svr_checkpoint() 415
- transactions
- See also checkpoint/refresh
- automatic retries of 35
- committing and continuing with os_transaction
- checkpoint() 43
- and deadlock 35
- globally scoped 53
- locally scoped 53
- multiple threads 50
- multiversion concurrency control 37
- nested 34
- priorities 35
- restriction 53
- transformer functions 342, 350, 357
- transient schemas
- modifying database schema 199
- updating database schema 191
- type creation, dynamic 187
- type_dumper
- defining and registering an instance of 302
U
- undo record 41
- update_size()
- os_collection, defined by 110
V
- verify
- os_collection, defined by 99
- victim, deadlock 35
[previous]
Copyright © 1997 Object Design, Inc. All rights
reserved.
Updated: 03/31/98 15:44:03