leo_cluster_tbl_member

The cluster member table operation.

References

Description

The cluster member table operation

Function Index

create_table/1 Create the member table.
create_table/3  
delete/1 Remove a record from the table.
delete/2  
delete/3  
delete_all/1 Remove all records.
delete_all/2  
find_all/0 Retrieve all members from the table.
find_all/1  
find_all/2  
find_by_alias/1 Retrieve records by alias.
find_by_alias/2  
find_by_alias/3  
find_by_level1/2 Retrieve records by L1 and L2.
find_by_level1/3  
find_by_level1/4  
find_by_level2/1 Retrieve records by L2.
find_by_level2/2  
find_by_level2/3  
find_by_name/2 Retrieve records by name.
find_by_name/3  
find_by_status/1 Retrieve members by status.
find_by_status/2  
find_by_status/3  
first/1  
insert/1 Insert a record into the table.
insert/2  
insert/3  
lookup/1 Retrieve a record by key from the table.
lookup/2  
lookup/3  
next/2  
overwrite/2 Overwrite current records by source records.
replace/2 Replace members into the db.
replace/3  
replace/4  
tab2list/0 Retrieve list from the table.
tab2list/1  
tab2list/2  
table_size/0 Retrieve total of records.
table_size/1  
table_size/2  
transform/0 Transform records.
transform/1  

Function Details

create_table/1

create_table(Table) -> ok

  • Table = member_table()

Create the member table.

create_table/3

create_table(DiscCopy, Nodes, Table) -> ok

  • DiscCopy = mnesia_copies()
  • Nodes = [atom()]
  • Table = member_table()

delete/1

delete(Node) -> ok | {error, any}

  • Node = atom()

Remove a record from the table.

delete/2

delete(Table, Node) -> ok | {error, any}

  • Table = member_table()
  • Node = atom()

delete/3

delete(DBType, Table, Node) -> ok | {error, any}

  • DBType = '?DB_ETS' | '?DB_MNESIA'
  • Table = member_table()
  • Node = atom()

delete_all/1

delete_all(Table) -> ok | {error, any()}

  • Table = member_table()

Remove all records

delete_all/2

delete_all(DBType, Table) -> ok | {error, any()}

  • DBType = '?DB_ETS' | '?DB_MNESIA'
  • Table = member_table()

find_all/0

find_all() -> {ok, [#member{}]} | not_found | {error, any()}

Retrieve all members from the table.

find_all/1

find_all(Table) -> {ok, [#member{}]} | not_found | {error, any()}

  • Table = member_table()

find_all/2

find_all(DBType, Table) -> {ok, [#member{}]} | not_found | {error, any()}

  • DBType = '?DB_ETS' | '?DB_MNESIA'
  • Table = member_table()

find_by_alias/1

find_by_alias(Alias) -> {ok, list()} | not_found | {error, any()}

  • Alias = string()

Retrieve records by alias

find_by_alias/2

find_by_alias(Table, Alias) -> {ok, list()} | not_found | {error, any()}

  • Table = atom()
  • Alias = string()

find_by_alias/3

find_by_alias(DBType, Table, Alias) -> {ok, list()} | not_found | {error, any()}

  • DBType = '?DB_MNESIA' | '?DB_ETS'
  • Table = atom()
  • Alias = string()

find_by_level1/2

find_by_level1(L1, L2) -> {ok, list()} | not_found | {error, any()}

  • L1 = atom()
  • L2 = atom()

Retrieve records by L1 and L2

find_by_level1/3

find_by_level1(Table, L1, L2) -> {ok, list()} | not_found | {error, any()}

  • Table = member_table()
  • L1 = atom()
  • L2 = atom()

find_by_level1/4

find_by_level1(DBType, Table, L1, L2) -> {ok, list()} | not_found | {error, any()}

  • DBType = '?DB_ETS' | '?DB_MNESIA'
  • Table = member_table()
  • L1 = atom()
  • L2 = atom()

find_by_level2/1

find_by_level2(L2) -> {ok, list()} | not_found | {error, any()}

  • L2 = atom()

Retrieve records by L2

find_by_level2/2

find_by_level2(Table, L2) -> {ok, list()} | not_found | {error, any()}

  • Table = member_table()
  • L2 = atom()

find_by_level2/3

find_by_level2(DBType, Table, L2) -> {ok, list()} | not_found | {error, any()}

  • DBType = '?DB_ETS' | '?DB_MNESIA'
  • Table = member_table()
  • L2 = atom()

find_by_name/2

find_by_name(Table, Name) -> {ok, list()} | not_found | {error, any()}

  • Table = atom()
  • Name = atom()

Retrieve records by name

find_by_name/3

find_by_name(DBType, Table, Name) -> {ok, list()} | not_found | {error, any()}

  • DBType = '?DB_MNESIA' | '?DB_ETS'
  • Table = atom()
  • Name = atom()

find_by_status/1

find_by_status(Status) -> {ok, [#member{}]} | not_found | {error, any()}

  • Status = atom()

Retrieve members by status

find_by_status/2

find_by_status(Table, Status) -> {ok, [#member{}]} | not_found | {error, any()}

  • Table = member_table()
  • Status = atom()

find_by_status/3

find_by_status(DBType, Table, Status) -> {ok, [#member{}]} | not_found | {error, any()}

  • DBType = '?DB_ETS' | '?DB_MNESIA'
  • Table = member_table()
  • Status = atom()

first/1

first(Table) -> atom() | '$end_of_table'

  • Table = atom()

insert/1

insert(Record) -> ok | {error, any}

  • Record = {atom(), #member{}}

Insert a record into the table.

insert/2

insert(Table, Record) -> ok | {error, any}

  • Table = member_table()
  • Record = {atom(), #member{}}

insert/3

insert(DBType, Table, Record) -> ok | {error, any}

  • DBType = '?DB_ETS' | '?DB_MNESIA'
  • Table = member_table()
  • Record = {atom(), #member{}}

lookup/1

lookup(Node) -> {ok, #member{}} | not_found | {error, any()}

  • Node = atom()

Retrieve a record by key from the table.

lookup/2

lookup(Table, Node) -> {ok, #member{}} | not_found | {error, any()}

  • Table = atom()
  • Node = atom()

lookup/3

lookup(DBType, Table, Node) -> {ok, #member{}} | not_found | {error, any()}

  • DBType = '?DB_ETS' | '?DB_MNESIA'
  • Table = atom()
  • Node = atom()

next/2

next(Table, MemberName) -> atom() | '$end_of_table'

  • Table = atom()
  • MemberName = atom()

overwrite/2

overwrite(SrcTable, DestTable) -> ok | {error, any()}

  • SrcTable = member_table()
  • DestTable = member_table()

Overwrite current records by source records

replace/2

replace(OldMembers, NewMembers) -> ok

  • OldMembers = [#member{}]
  • NewMembers = [#member{}]

Replace members into the db.

replace/3

replace(Table, OldMembers, NewMembers) -> ok

  • Table = member_table()
  • OldMembers = [#member{}]
  • NewMembers = [#member{}]

replace/4

replace(DBType, Table, OldMembers, NewMembers) -> ok

  • DBType = '?DB_ETS' | '?DB_MNESIA'
  • Table = member_table()
  • OldMembers = [#member{}]
  • NewMembers = [#member{}]

tab2list/0

tab2list() -> list() | {error, any()}

Retrieve list from the table.

tab2list/1

tab2list(Table) -> list() | {error, any()}

  • Table = member_table()

tab2list/2

tab2list(DBType, Table) -> list() | {error, any()}

  • DBType = '?DB_ETS' | '?DB_MNESIA'
  • Table = member_table()

table_size/0

table_size() -> integer() | {error, any()}

Retrieve total of records.

table_size/1

table_size(Table) -> integer() | {error, any()}

  • Table = atom()

table_size/2

table_size(DBType, Table) -> integer() | {error, any()}

  • DBType = '?DB_ETS' | '?DB_MNESIA'
  • Table = atom()

transform/0

transform() -> ok | {error, any()}

Transform records

transform/1

transform(MnesiaNodes) -> ok | {error, any()}

  • MnesiaNodes = [atom()]