summaryrefslogtreecommitdiff
path: root/docs/reference/mapping/meta.asciidoc
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/mapping/meta.asciidoc')
-rw-r--r--docs/reference/mapping/meta.asciidoc25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/reference/mapping/meta.asciidoc b/docs/reference/mapping/meta.asciidoc
new file mode 100644
index 0000000..5cb0c14
--- /dev/null
+++ b/docs/reference/mapping/meta.asciidoc
@@ -0,0 +1,25 @@
+[[mapping-meta]]
+== Meta
+
+Each mapping can have custom meta data associated with it. These are
+simple storage elements that are simply persisted along with the mapping
+and can be retrieved when fetching the mapping definition. The meta is
+defined under the `_meta` element, for example:
+
+[source,js]
+--------------------------------------------------
+{
+ "tweet" : {
+ "_meta" : {
+ "attr1" : "value1",
+ "attr2" : {
+ "attr3" : "value3"
+ }
+ }
+ }
+}
+--------------------------------------------------
+
+Meta can be handy for example for client libraries that perform
+serialization and deserialization to store its meta model (for example,
+the class the document maps to).