0.13
Getting started with DBOO
DBOO
Features
How
Download and install
Developer packages
C++ SDK
C# SDK
Node.JS
Server Installation
macOS
Linux
Managing server instances
Creating a server instance
Starting a server instance
Creating databases
Setting the root password
Create a user
Create a database
C++ example
Code
Build with DBOO
Running DBOO
Try the example program
Node.js example
Code
Set up environment
Running DBOO
Try the example program
The dboo command line
Batch mode
Interactive mode
Redirection while in interactive mode
Auto completion
Connecting to the server database
Useful server commands
Connecting to a user database
Query commands
Changing password
Backup & restore commands
Concept
Inserting / Retrieving Objects
Pointers, References and Relationships
Object Graphs, Deep Copies & Light References
Inheritance & Polymorphism
Memory management
Building clients using the DBOO API
Overview
Class declaration
Classes
Class registry
Type id/class name
Requirements on classes
The cls<> class (C++)
Class initialization function (C++)
Member Fields
Base Classes
Post Internalization Function
Class function (Node.js)
Datatypes with examples
Implementation status
Primitives
Strings
Pointers and references
Containers
Value composition
Inheritance
Datetime
Runtime objects
Object id
Object lifetime
Commits
Object version
Marking objects as updated
Traversing the object graph
API
Controlling disk sync, caching and storage behaviour
Fetching objects
request
select
ref
Object graphs
Transactions
Version handling
Rename member in class
Rename member in class
Rename member in base class
Rename member in an embedded class
Rename class
Rename class
Rename a class that is a member in another class
Rename a class that is a base of another class
Remove a member
Add a member
Change the type of a member
Add or remove a base class
Summary table of version handling cases
Managing the server and indices
The server
Command line options
Creating a server instance
Running the server
Databases
Create a database
Users and groups
Root user
Adding users and groups
Reset root password
Index overview
Types of indices
Core index
Reference index
Type index
Field index
Index caching
Update buffer
Index API
Creating indices
Rebuilding indices
Deleting indices
Modifying indices
Options
Backup and restore
DBOO manager
Interactive mode
Connecting to the server database
Connecting to a user database
Connection parameters
Command completion
Input & output operators
Queries with long output
Ctrl-C
Exit the DBOO manager
Non interactive mode
Connection parameters
Example
Commands
add group
Arguments
Options
Example
add user
Arguments
Options
Example
backup
Options
Example
config
Arguments
Example
connect
Arguments
Options
Example
count<class>([<expression>])
Options
Example
create database
Arguments
Options
Example
create index
Arguments
Options
Example
dbconfig list
Arguments
Options
Example
drop database
Arguments
Options
Example
drop group
Arguments
Options
Example
drop index
Arguments
Options
Example
drop user
Arguments
Options
Example
erase<class>([<expression>])
Options
Example
exit
Example
help
Arguments
Options
Example
list classes
Options
Example
list databases
Options
Example
list groups
Options
Example
list indices
Arguments
Options
Example
list users
Options
Example
modify database
Arguments
Options
Example
modify group
Arguments
Options
Example
modify index
Arguments
Options
Example
modify user
Arguments
Options
Example
print class
Arguments
Options
Example
quit
Example
rebuild all indices
Options
Example
rebuild index
Arguments
Options
Example
request<class>([<expression>])
Options
Example
restore
Options
Example
select<class>([<expression>])
Options
Example
server logs
Options
Example
set password
Options
Example
version
Options
Example
API Reference
dboo::init
Parameters
Return value
Exceptions
Example
dboo.class (Node.js)
Parameters
Return value
Exceptions
Example
dboo::odb
Usage
Server database
Member functions
dboo::odb::escape_string
dboo::odb::constructor
dboo::odb::connect
dboo::odb::is_connected
dboo::odb::close
dboo::odb::define
dboo::odb::commit
dboo::odb::commit_all
dboo::odb::updated
dboo::odb::updated_objects
dboo::odb::request
dboo::odb::select
dboo::odb::query
dboo::odb::fetch
dboo::odb::count
dboo::odb::erase
dboo::odb::create_index
dboo::odb::rebuild_index
dboo::odb::delete_index
dboo::odb::modify_index
dboo::odb::rebuild_index
dboo::odb::indices
dboo::odb::backup_database
dboo::odb::restore_database
dboo::odb::change_user_password
dboo::odb::host
dboo::odb::user_id
dboo::odb::database_name
dboo::odb::port
dboo::odb::mk_id
dboo::odb::set_id
dboo::odb::object
dboo::odb::object_id
dboo::odb::free_all
dboo::odb::rmobj
dboo::odb::rmobj_r
dboo::odb::load_types
dboo::odb::clear_state
dboo::odb::client_version
dboo::odb::server_version
dboo::odb::client_stats
dboo::odb::db_stats
dboo::odb::throw_on_undefined
Server functions
dboo::odb::create_database
dboo::odb::drop_database
dboo::odb::add_group
dboo::odb::add_user
dboo::odb::init_server
dboo::odb::start_server
dboo::odb::stop_server
dboo::odb::user_groups
dboo::cls (C++)
Member functions
dboo::cls::constructor
dboo::cls::base
dboo::cls::member
dboo_class_init
dboo::version_handler
Usage
Member functions
dboo::version_handler::convert
dboo::version_handler::do_ii_to_rt_conversion
dboo::version_handler::get_mbr_cvt
dboo::version_handler::get_mbr_removed
dboo::version_handler::get_old_class_id
dboo::version_handler::has_ii_to_ii_converter
dboo::version_handler::has_ii_to_rt_converter
dboo::version_handler::has_old_class_id
dboo::version_handler::member_new_name
dboo::version_handler::member_renamed
dboo::version_handler::removed_member
dboo::version_handler::rename_member
dboo::version_handler::retype_member
dboo::ref
Member functions
Query language
Overview
C++
Node.js
DBOO Command line
Value comparator
Example
Set comparator
Example
Set operator
Example
Grammar
»
API Reference
»
dboo::ref
dboo::ref
The ref class is used for lazy loading objects.
Member functions
Index