summaryrefslogtreecommitdiff
path: root/docs-xml
diff options
context:
space:
mode:
authorRalph Boehme <slow@samba.org>2021-10-13 19:16:10 +0200
committerNoel Power <npower@samba.org>2021-10-14 10:20:27 +0000
commit71cef2fa1ddbe05d29e7ce571a35888ef4663b22 (patch)
tree432c5cc7c5ad2de0eee73cb4d2cdf696e0229d0d /docs-xml
parent8e3372eceab1bc7ad8ac813b12d654c979e20769 (diff)
downloadsamba-71cef2fa1ddbe05d29e7ce571a35888ef4663b22.tar.gz
docs: document new Spotlight Elasticsearch options
elasticsearch:ignore unknown attribute = yes | no (default: no) elasticsearch:ignore unknown type = yes | no (default: no) Signed-off-by: Ralph Boehme <slow@samba.org> Reviewed-by: Noel Power <npower@samba.org> Autobuild-User(master): Noel Power <npower@samba.org> Autobuild-Date(master): Thu Oct 14 10:20:27 UTC 2021 on sn-devel-184
Diffstat (limited to 'docs-xml')
-rw-r--r--docs-xml/smbdotconf/misc/elasticsearchignoreunknownattribute.xml19
-rw-r--r--docs-xml/smbdotconf/misc/elasticsearchignoreunknowntype.xml19
2 files changed, 38 insertions, 0 deletions
diff --git a/docs-xml/smbdotconf/misc/elasticsearchignoreunknownattribute.xml b/docs-xml/smbdotconf/misc/elasticsearchignoreunknownattribute.xml
new file mode 100644
index 00000000000..86368d30e58
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/elasticsearchignoreunknownattribute.xml
@@ -0,0 +1,19 @@
+<samba:parameter name="elasticsearch:ignore unknown attribute"
+ context="G"
+ type="boolean"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+ <description>
+ <para>
+ Ignore unknown Spotlight attributes in search queries. An example query
+ using the unsupported attribute
+ <literal>&quot;kMDItemTopic&quot;</literal> would be
+ <literal>kMDItemTopic==&quot;hotstuff&quot;</literal>. By
+ default any query using such a type would completely fail. By enabling
+ this option, if the type match is a subexpression of a larger expression,
+ then this subexpression is just ignored.
+ </para>
+ </description>
+
+ <value type="default">no</value>
+ <value type="example">yes</value>
+</samba:parameter>
diff --git a/docs-xml/smbdotconf/misc/elasticsearchignoreunknowntype.xml b/docs-xml/smbdotconf/misc/elasticsearchignoreunknowntype.xml
new file mode 100644
index 00000000000..ca1f873adac
--- /dev/null
+++ b/docs-xml/smbdotconf/misc/elasticsearchignoreunknowntype.xml
@@ -0,0 +1,19 @@
+<samba:parameter name="elasticsearch:ignore unknown type"
+ context="G"
+ type="boolean"
+ xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
+ <description>
+ <para>
+ Ignore unknown Spotlight types in search queries. An example query using
+ the unsupported type <literal>&quot;public.calendar-event&quot;</literal>
+ would be
+ <literal>kMDItemContentType==&quot;public.calendar-event&quot;</literal>. By
+ default any query using such a type would completely fail. By enabling
+ this option, if the type match is a subexpression of a larger expression,
+ then this subexpression is just ignored.
+ </para>
+ </description>
+
+ <value type="default">no</value>
+ <value type="example">yes</value>
+</samba:parameter>