The API documentation is automagically generated with Doxygen from the central header file upscaledb.h. It lists all functions, macros, constants, status codes and structures. It is the most authoritative documentation available and is available online.
If you want to create or open Databases or Environments (a collection of multiple Databases), the following functions will be interesting for you:
| ups_env_create | Creates an Environment |
| ups_env_open | Opens an Environment |
| ups_env_close | Closes an Environment |
| ups_env_create_db | Creates a Database in an Environment |
| ups_env_open_db | Opens a Database from an Environment |
| ups_db_close | Closes a Database |
To insert, lookup or delete key/value pairs, the following functions are used:
| ups_db_insert | Inserts a key/value pair into a Database |
| ups_db_find | Lookup of a key/value pair in a Database |
| ups_db_erase | Erases a key/value pair from a Database |
Alternatively, you can use Cursors to iterate over a Database:
| ups_cursor_create | Creates a new Cursor |
| ups_cursor_find | Positions the Cursor on a key |
| ups_cursor_insert | Inserts a new key/value pair with a Cursor |
| ups_cursor_erase | Deletes the key/value pair that the Cursor points to |
| ups_cursor_overwrite | Overwrites the value of the current key |
| ups_cursor_move | Moves the Cursor to the first, next, previous or last key in the Database |
| ups_cursor_close | Closes the Cursor |
If you want to use Transactions, then the following functions are required:
| ups_txn_begin | Begins a new Transaction |
| ups_txn_commit | Commits the current Transaction |
| ups_txn_abort | Aborts the current Transaction |
upscaledb supports remote Databases. The server can be embedded into your application or run standalone (see tools/upszilla for a Unix daemon or Win32 service which hosts Databases). If you want to embed the server then the following functions have to be used:
| ups_srv_init | Initializes the server |
| ups_srv_add_env | Adds an Environment to the server. The Environment with all its Databases will then be available remotely. |
| ups_srv_close | Closes the server and frees all allocated resources |
If you need help then you're always welcome to use the mailing list, drop a message (info@upscaledb.com) or use the contact form.
Have fun!