aboutsummaryrefslogtreecommitdiffstats
path: root/lib/mnesia/doc/src/mnesia_registry.xml
diff options
context:
space:
mode:
Diffstat (limited to 'lib/mnesia/doc/src/mnesia_registry.xml')
-rw-r--r--lib/mnesia/doc/src/mnesia_registry.xml85
1 files changed, 40 insertions, 45 deletions
diff --git a/lib/mnesia/doc/src/mnesia_registry.xml b/lib/mnesia/doc/src/mnesia_registry.xml
index ad2b927315..c4b5bdc59a 100644
--- a/lib/mnesia/doc/src/mnesia_registry.xml
+++ b/lib/mnesia/doc/src/mnesia_registry.xml
@@ -34,71 +34,66 @@
<file>mnesia_registry.sgml</file>
</header>
<module>mnesia_registry</module>
- <modulesummary>Dump support for registries in erl_interface. </modulesummary>
+ <modulesummary>Dump support for registries in erl_interface.</modulesummary>
<description>
- <p>The module <c>mnesia_registry</c> is usually part of
- <c>erl_interface</c>, but for the time being, it is a part of the
- Mnesia application.
- </p>
- <p><c>mnesia_registry</c> is mainly an module intended for
- internal usage within OTP, but it has two functions that
- are exported for public use.
- </p>
- <p>On C-nodes <c>erl_interface</c> has support for registry
- tables. These reside in RAM on the C-node but they may also be
- dumped into Mnesia tables. By default, the dumping of registry
- tables via <c>erl_interface</c> causes a corresponding Mnesia
- table to be created with <c>mnesia_registry:create_table/1</c>
- if necessary.
- </p>
- <p>The tables that are created with these functions can be
- administered as all other Mnesia tables. They may be included in
- backups or replicas may be added etc. The tables are in fact
- normal Mnesia tables owned by the user of the corresponding
- <c>erl_interface</c> registries.
- </p>
+ <p>This module is usually part of the <c>erl_interface</c>
+ application, but is currently part of the <c>Mnesia</c>
+ application.</p>
+ <p>This module is mainly intended for internal use within OTP,
+ but it has two functions that are exported for public use.</p>
+ <p>On C-nodes, <c>erl_interface</c> has support for registry
+ tables. These tables reside in RAM on the C-node, but can also
+ be dumped into <c>Mnesia</c> tables. By default, the dumping
+ of registry tables through <c>erl_interface</c> causes a
+ corresponding <c>Mnesia</c> table to be created with
+ <c>mnesia_registry:create_table/1</c>, if necessary.</p>
+ <p>Tables that are created with these functions can be
+ administered as all other <c>Mnesia</c> tables. They can be
+ included in backups, replicas can be added, and so on.
+ The tables are normal <c>Mnesia</c> tables owned by the user
+ of the corresponding <c>erl_interface</c> registries.</p>
</description>
+
<funcs>
<func>
<name>create_table(Tab) -> ok | exit(Reason)</name>
<fsummary>Creates a registry table in Mnesia.</fsummary>
<desc>
- <p>This is a wrapper function for
- <c>mnesia:create_table/2</c> which creates a table (if there is no existing table)
- with an appropriate set of <c>attributes</c>. The table will
- only reside on the local node and its storage type will be
- the same as the <c>schema</c> table on the local
- node, ie. <c>{ram_copies,[node()]}</c> or
- <c>{disc_copies,[node()]}</c>.
- </p>
- <p>It is this function that is used by <c>erl_interface</c> to
- create the Mnesia table if it did not already exist.</p>
+ <p>A wrapper function for <c>mnesia:create_table/2</c>,
+ which creates a table (if there is no existing table)
+ with an appropriate set of <c>attributes</c>. The table
+ only resides on the local node and its storage type is
+ the same as the <c>schema</c> table on the local node,
+ that is, <c>{ram_copies,[node()]}</c> or
+ <c>{disc_copies,[node()]}</c>.</p>
+ <p>This function is used by <c>erl_interface</c> to
+ create the <c>Mnesia</c> table if it does not already
+ exist.</p>
</desc>
</func>
<func>
<name>create_table(Tab, TabDef) -> ok | exit(Reason)</name>
- <fsummary>Creates a customized registry table in Mnesia. </fsummary>
+ <fsummary>Creates a customized registry table in Mnesia.</fsummary>
<desc>
- <p>This is a wrapper function for
- <c>mnesia:create_table/2</c> which creates a table (if there is no existing table)
- with an appropriate set of <c>attributes</c>. The attributes
- and <c>TabDef</c> are forwarded to
- <c>mnesia:create_table/2</c>. For example, if the table should
- reside as <c>disc_only_copies</c> on all nodes a call would
- look like:</p>
+ <p>A wrapper function for <c>mnesia:create_table/2</c>,
+ which creates a table (if there is no existing table)
+ with an appropriate set of <c>attributes</c>. The
+ attributes and <c>TabDef</c> are forwarded to
+ <c>mnesia:create_table/2</c>. For example, if the table
+ is to reside as <c>disc_only_copies</c> on all nodes,
+ a call looks as follows:</p>
<code type="none">
TabDef = [{{disc_only_copies, node()|nodes()]}],
- mnesia_registry:create_table(my_reg, TabDef)
- </code>
+ mnesia_registry:create_table(my_reg, TabDef)</code>
</desc>
</func>
</funcs>
<section>
<title>See Also</title>
- <p>mnesia(3), erl_interface(3)
- </p>
+ <p><seealso marker="erl_interface:index">erl_interface(3)</seealso>,
+ <seealso marker="mnesia:mnesia">mnesia(3)</seealso></p>
</section>
-
+
</erlref>