mnesia_rocksdb/doc/mnesia_rocksdb_admin.md

Module mnesia_rocksdb_admin

• Data Types
• Function Index
• Function Details

Behaviours: gen_server.

Data Types

alias()

alias() = atom()

backend()

backend() = #{db_ref => db_ref(), cf_info => #{table() => cf()}}

cf()

cf() = mrdb:db_ref()

db_ref()

db_ref() = rocksdb:db_handle()

gen_server_noreply()

gen_server_noreply() = {noreply, st()} | {stop, reason(), st()}

gen_server_reply()

gen_server_reply() = {reply, reply(), st()} | {stop, reason(), reply(), st()}

properties()

properties() = [{atom(), any()}]

reason()

reason() = any()

reply()

reply() = any()

req()

req() = {create_table, table(), properties()} | {delete_table, table()} | {load_table, table(), properties()} | {related_resources, table()} | {get_ref, table()} | {add_aliases, [alias()]} | {write_table_property, tabname(), tuple()} | {remove_aliases, [alias()]} | {migrate, [tabname() | {tabname(), map()}], rpt()} | {prep_close, table()} | {close_table, table()} | {clear_table, table() | cf()}

rpt()

rpt() = undefined | map()

st()

st() = #st{backends = #{alias() => backend()}, standalone = #{{alias(), table()} => cf()}, default_opts = [{atom(), term()}]}

table()

table() = tabname() | {admin, alias()} | {tabname(), index, any()} | {tabname(), retainer, any()}

tabname()

tabname() = atom()

Function Index

add_aliases/1
clear_table/1
close_table/2
code_change/3
create_table/3
delete_info/3
delete_table/2
ensure_started/0
get_cached_env/2
get_ref/1
get_ref/2
handle_call/3
handle_cast/2
handle_info/2
init/1
load_table/3
meta/0
migrate_standalone/2
migrate_standalone/3
prep_close/2
read_info/1
read_info/2
read_info/4
related_resources/2
remove_aliases/1
request_ref/2
set_and_cache_env/2
start_link/0
terminate/2
write_info/4
write_table_property/3

Function Details

add_aliases/1

add_aliases(Aliases) -> any()

clear_table/1

clear_table(Name) -> any()

close_table/2

close_table(Alias, Name) -> any()

code_change/3

code_change(FromVsn, St, Extra) -> any()

create_table/3

create_table(Alias, Name, Props) -> any()

delete_info/3

delete_info(Alias, Tab, K) -> any()

delete_table/2

delete_table(Alias::alias(), Name::tabname()) -> ok

ensure_started/0

ensure_started() -> ok

get_cached_env/2

get_cached_env(Key, Default) -> any()

get_ref/1

get_ref(Name) -> any()

get_ref/2

get_ref(Name, Default) -> any()

handle_call/3

handle_call(Req::{alias(), req()}, From::any(), St::st()) -> gen_server_reply()

handle_cast/2

handle_cast(Msg::any(), St::st()) -> gen_server_noreply()

handle_info/2

handle_info(Msg::any(), St::st()) -> gen_server_noreply()

init/1

init(X1) -> any()

load_table/3

load_table(Alias, Name, Props) -> any()

meta/0

meta() -> any()

migrate_standalone/2

migrate_standalone(Alias::alias(), Tabs) -> Res

• Tabs = [tabname() | {tabname(), map()}]
• Res = [{tabname(), {ok, any()} | {error, any()}}]

migrate_standalone/3

migrate_standalone(Alias::alias(), Tabs, Rpt) -> Res

• Tabs = [tabname() | {tabname(), map()}]
• Rpt = undefined | pid() | atom()
• Res = [{tabname(), {ok, any()} | {error, any()}}]

prep_close/2

prep_close(Alias, Tab) -> any()

read_info/1

read_info(TRec) -> any()

read_info/2

read_info(Alias, Tab) -> any()

read_info/4

read_info(Alias, Tab, K, Default) -> any()

related_resources/2

related_resources(Alias, Name) -> any()

remove_aliases/1

remove_aliases(Aliases) -> any()

request_ref/2

request_ref(Alias, Name) -> any()

set_and_cache_env/2

set_and_cache_env(Key, Value) -> any()

start_link/0

start_link() -> any()

terminate/2

terminate(X1, St) -> any()

write_info/4

write_info(Alias, Tab, K, V) -> any()

write_table_property/3

write_table_property(Alias, Tab, Prop) -> any()