Index¶
- Main YottaDB Documentation Page
- Multi-Language Programmer's Guide
- Programming in M
- Programming in C
- Sample Program
- Symbolic Constants
- Function Return Codes
- Normal Return Codes
- Error Return Codes
- YDB_ERR_CALLINAFTERXIT
- YDB_ERR_FATALERROR1
- YDB_ERR_FATALERROR2
- YDB_ERR_GVUNDEF
- YDB_ERR_INVNAMECOUNT
- YDB_ERR_INSUFFSUBS
- YDB_ERR_INVSTRLEN
- YDB_ERR_INVSVN
- YDB_ERR_INVVARNAME
- YDB_ERR_KEY2BIG
- YDB_ERR_LVUNDEF
- YDB_ERR_MAXNRSUBSCRIPTS
- YDB_ERR_MINNRSUBSCRIPTS
- YDB_ERR_NAMECOUNT2HI
- YDB_ERR_NODEEND
- YDB_NOTOK
- YDB_ERR_NUMOFLOW
- YDB_ERR_PARAMINVALID
- YDB_ERR_SIMPLEAPINEST
- YDB_ERR_SUBSARRAYNULL
- YDB_ERR_SVNOSET
- YDB_ERR_TIME2LONG
- YDB_ERR_TPTIMEOUT
- YDB_ERR_UNIMPLOP
- YDB_ERR_VARNAME2LONG
- Limits
- Severity
- Other
- Function Return Codes
- Data Structures & Type Definitions
- Macros
- YDB_ASSERT(x)
- YDB_BUFFER_IS_SAME(buffer1, buffer2)
- YDB_COPY_BUFFER_TO_BUFFER(source, destination, done)
- YDB_COPY_LITERAL_TO_BUFFER(literal, buffer, done)
- YDB_COPY_STRING_TO_BUFFER(string, buffer, done)
- YDB_FREE_BUFFER(BUFFERP)
- YDB_LITERAL_TO_BUFFER(literal, buffer)
- YDB_IS_YDBERR(msgnum)
- YDB_MALLOC_BUFFER(BUFFERP,LEN)
- YDB_SEVERITY(msgnum, severity)
- HASH128_STATE_INIT(hash128_state_t *state, ydb_uint8 addl_seed)
- YDB_STRING_TO_BUFFER
- Simple API
- ydb_data_s() / ydb_data_st()
- ydb_delete_s() / ydb_delete_st()
- ydb_delete_excl_s() / ydb_delete_excl_st()
- ydb_get_s() / ydb_get_st()
- ydb_incr_s() / ydb_incr_st()
- ydb_lock_s() / ydb_lock_st()
- ydb_lock_decr_s() / ydb_lock_decr_st()
- ydb_lock_incr_s() / ydb_lock_incr_st()
- ydb_node_next_s() / ydb_node_next_st()
- ydb_node_previous_s() / ydb_node_previous_st()
- ydb_set_s() / ydb_set_st()
- ydb_str2zwr_s() / ydb_str2zwr_st()
- ydb_subscript_next_s() / ydb_subscript_next_st()
- ydb_subscript_previous_s() / ydb_subscript_previous_st()
- ydb_tp_s() / ydb_tp_st()
- ydb_zwr2str_s() / ydb_zwr2str_st()
- Comprehensive API
- YottaDB C to M APIs
- Utility Functions
- ydb_call_variadic_plist_func()
- ydb_child_init()
- ydb_eintr_handler() / ydb_eintr_handler_t()
- ydb_exit()
- ydb_file_id_free() / ydb_file_id_free_t()
- ydb_file_is_identical() / ydb_file_is_identical_t()
- ydb_file_name_to_id() / ydb_file_name_to_id_t()
- ydb_fork_n_core()
- ydb_free()
- ydb_hiber_start()
- ydb_hiber_start_wait_any()
- ydb_init()
- ydb_malloc()
- ydb_message() / ydb_message_t()
- ydb_mmrhash_32()
- ydb_mmrhash_128()
- ydb_mmrhash_128_ingest() / ydb_mmrhash_128_result()
- ydb_mmrhash_128_hex()
- ydb_mmrhash_128_bytes()
- ydb_stdout_stderr_adjust() / ydb_stdout_stderr_adjust_t()
- ydb_thread_is_main()
- ydb_timer_cancel() / ydb_timer_cancel_t()
- ydb_timer_start() / ydb_timer_start_t()
- Calling M Routines
- Programming in Go
- Go Quick Start
- Go Concepts
- Go Constants
- Go Symbolic Constants
- Go Easy API
- Go Simple API
- Go Data Structures & Type Definitions
- Go Wrapper Functions
- Go CallMT()
- Go DataE()
- Go DeleteE()
- Go DeleteExclE()
- Go ErrorCode()
- Go Exit()
- Go IncrE()
- Go Init()
- Go IsLittleEndian()
- Go LockDecrE()
- Go LockE()
- Go LockIncrE()
- Go LockST()
- Go MessageT()
- Go NewError()
- Go NodeNextE()
- Go NodePrevE()
- Go RegisterSignalNotify()
- Go ReleaseT()
- Go SetValE()
- Go SubNextE()
- Go SubPrevE()
- Go TpE()
- Go UnRegisterSignalNotify()
- Go ValE()
- Go BufferT Alloc()
- Go BufferT Dump()
- Go BufferT DumpToWriter()
- Go BufferT Free()
- Go BufferT LenAlloc()
- Go BufferT LenUsed()
- Go BufferT SetLenUsed()
- Go BufferT SetValBAry()
- Go BufferT SetValStr()
- Go BufferT Str2ZwrST()
- Go BufferT ValBAry()
- Go BufferT ValStr()
- Go BufferT Zwr2StrST()
- Go BufferTArray Alloc()
- Go BufferTArray DeleteExclST()
- Go BufferTArray Dump()
- Go BufferTArray DumpToWriter()
- Go BufferTArray ElemAlloc()
- Go BufferTArray ElemLenAlloc()
- Go BufferTArray ElemLenUsed()
- Go BufferTArray ElemUsed()
- Go BufferTArray Free()
- Go BufferTArray SetElemLenUsed()
- Go BufferTArray SetElemUsed()
- Go BufferTArray SetValBAry()
- Go BufferTArray SetValStr()
- Go BufferTArray TpST()
- Go BufferTArray ValBAry()
- Go BufferTArray ValStr()
- Go CallMDesc CallMDescT()
- Go CallMDesc Free()
- Go CallMDesc SetRtnName()
- Go CallMTable CallMTableOpenT()
- Go CallMTable CallMTableSwitchT()
- Go KeyT Alloc()
- Go KeyT DataST()
- Go KeyT DeleteST()
- Go KeyT Dump()
- Go KeyT DumpToWriter()
- Go KeyT Free()
- Go KeyT IncrST()
- Go KeyT LockDecrST()
- Go KeyT LockIncrST()
- Go KeyT NodeNextST()
- Go KeyT NodePrevST()
- Go KeyT SetValST()
- Go KeyT SubNextST()
- Go KeyT SubPrevST()
- Go KeyT ValST()
- Go Error()
- Go Programming Notes
- Programming in JavaScript
- Programming in Lua
- Installation
- Introduction by example
- Lua API
- Basic low level functions
- block_M_signals (bool)
- data (varname[, subsarray[, …]])
- delete_node (varname[, subsarray[, …]]) [deprecated v3.0]:
- delete_tree (varname[, subsarray[, …]]) [deprecated v3.0]:
- get (varname[, subsarray[, …]])
- get_error_code (message)
- grab (varname[, subsarray[, …[, timeout]]])
- incr (varname[, subsarray][, …], increment)
- init ([signal_blocker])
- kill (varname[, subsarray[, …]])
- lock ([nodes[, timeout]])
- lock_decr (varname[, subsarray[, …]])
- lock_incr (varname[, subsarray[, …[, timeout]]])
- node_next (varname[, subsarray[, …]])
- node_previous (varname[, subsarray[, …]])
- release (varname[, subsarray[, …]])
- set (varname[, subsarray][, …], value)
- str2zwr (s)
- subscript_next (varname[, subsarray[, …]])
- subscript_previous (varname[, subsarray[, …]])
- subscripts (varname[, subsarray[, …[, reverse]]])
- ydb_eintr_handler ()
- zwr2str (s)
- Transactions
- High level functions
- Node class operations
- Node class
- node:__ipairs ()
- node:__pairs ([reverse])
- node:__repr ()
- node:delete_tree () [deprecated v3.0]:
- node:dump ([maxlines=30])
- node:get ([default])
- node:gettree ([maxdepth[, filter[, _value[, _depth]]]])
- node:grab ([timeout])
- node:incr ([increment=1])
- node:kill ()
- node:lock ([timeout])
- node:lock_decr ()
- node:lock_incr ([timeout])
- node:release ()
- node:set (value)
- node:settree (tbl[, filter[, _seen]])
- node:subscripts ([reverse])
- Node class properties
- Key class
- Basic low level functions
- Programming in Perl
- Perl Quick Start
- Functions
- $data = y_data $var [, @subs]
- y_killall ()
- y_kill_excl [$var0 [,$var1 [,…]]]
- y_kill_node $var [, @subs]
- y_kill_tree $var [, @subs]
- y_set $var, [@subs,] $value
- $value = y_get $var [, @subs]
- $value = y_get_croak $var [, @subs]
- $value = y_next $var [, @subs]
- $value = y_previous $var [, @subs]
- (@subs) = y_node_next $var [, @subs]
- (@subs) = y_node_previous $var [, @subs]
- $incval = y_incr $var [, @subs], $increment
- $string = y_zwr2str $zwr_encoded_string
- $zwrstring = y_str2zwr $string
- $status = y_lock $timeout [, @name1 [, @name2 [,…]]]
- $status = y_lock_incr $timeout, $var [, @subs]
- y_lock_decr $var [, @subs]
- $status = y_trans (&code, $tansid [, lvar0 [, lvar1 …]])
- Programming in PHP
- Programming in Python
- Python Quick Start
- Python Concepts
- Python Symbolic Constants
- Python API
- Python Data Structures & Type Definitions
- Python Wrapper Functions
- Python ci()
- Python cip()
- Python data()
- Python delete_node()
- Python delete_tree()
- Python get()
- Python incr()
- Python lock()
- Python lock_decr()
- Python lock_incr()
- Python message()
- Python node_next()
- Python node_previous()
- Python nodes()
- Python open_ci_table()
- Python release()
- Python set()
- Python str2zwr()
- Python subscript_next()
- Python subscript_previous()
- Python subscripts()
- Python switch_ci_table()
- Python tp()
- Python transaction()
- Python zwr2str()
- YottaDB Key class properties
- YottaDB Key class regular methods
- YottaDB Key class magic methods
- Programming in Rust
- Getting Started
- Rust API
- Macros
- Struct yottadb::Context
- Struct yottadb::KeyContext
- data()
- delete()
- get()
- get_and_parse()
- increment()
- iter_key_nodes()
- iter_key_nodes_reverse()
- iter_key_subs()
- iter_key_subs_reverse()
- iter_nodes()
- iter_nodes_reverse()
- iter_subs()
- iter_subs_reverse()
- iter_subs_values()
- iter_subs_values_reverse()
- iter_values()
- iter_values_reverse()
- lock_decr()
- lock_incr()
- new()
- next_node()
- next_node_self()
- next_sub()
- next_sub_self()
- prev_node()
- prev_node_self()
- prev_sub()
- prev_sub_self()
- set()
- variable()
- with_key()
- Advantages of the Rust wrapper
- Programming Notes (Avoiding Common Pitfalls)
- LICENSE