Skip to content

Commit

Permalink
Merge 7.0 changes forward to 7.1 (#2430)
Browse files Browse the repository at this point in the history
* DOC-8454 add sizing information to server docs (#2323)

* Update AWS Marketplace Deployment instructions (#2335)

* list tweak (#2336)

* missing [] (#2337)

* DOC-9455 CE to EE Upgrade Path needs to be clarified (#2311)

* MB-50105 - Add documentation for Disk Encryption to AWS Best Practices (#2333)
  MB-50104 - Add documentation for Secret Manager Secret Access and Rotation to AWS Best Practices

* DOC-9120: improve description of event rebalancing (#2214)

* correct typo "THe" -> "The" (#2342)

* MB-48904 Version 7.0 - Need to remove cbdocloader code snippet #2299

* Fixed spelling mistake. (#2340)

* Fixing Couchbase tickets drop 3 (#2319)

* DOC-9515 "Couchbase Client Deployment Strategies" link goes to the generic SDK intro. (#2349)

* DOC-9540: Clarify formulations for setup (#2352)

* DOC-9491: Added ports 11280 and 9123. Moved 9124. (#2328)

* DOC-9521 Inconsistency between Table 1 and Table 2 sections (#2351)

* Fixed issues reported by Sreekanth (#2362)

* DOC-9471: Removed duplicate nav entry (#2313)

* DOC-9286: Fixed typo (#2241)

* DOC-9550: Corrected pathname (#2366)

* [DOC-9566] External users should use TLS when communicating with cluster (#2364)

* DOC-9585: Rename fts-creating-index.adoc to fts-creating-indexes.adoc (#2377)

* Update cluster-manager.adoc (#2359)

* Doc 9499 document how to use an external prometheus to consume couchbase stats (#2360)

* DOC-9481: Typo in the documentation header (#2376)

* tutorial fix for new couchbase download page (#2389)

* DOC-9196: How-to Guides for Server Developers (#2373)

* DOC-9204: Developer Guides Overview (#2224)

* DOC-9206: How-to Guides for Server Developers: Query — Read Data (#2249)

* DOC-9207: Query — Manipulate Data (#2277)

* DOC-9205 - KV Operations dev-reorg (#2275)

* DOC-9217: How-to Guides for Server Developers › Index Advisor (#2331)

  - DOC-9240: Restore query result tree
  - DOC-9240: Add patch release markup for 7.0-7.0.1
  - DOC-9018: Move Charts section under Query Results and rewrite for Couchbase Server 7.0.2

* DOC-9216: Import Data guide (#2317)

* DOC-9210:  How-to Guides for Server Developers › Transactions (#2353)

* DOC-9209: How-to Guides for Server Developers › Query › Indexes (#2307)

* DOC-9412 - Connect to server (#2339)

* DOC-9204: Developer Guides Overview (#2371)

  - DOC-9209: transaction fixes
  - DOC-9216: Minor wording changes for consistency
  - DOC-9412: Update nav and overview page

* DOC-8818: node-to-node encryption and eventing storage (#2385)

* DOC-9294 improve terminology avoid function/handler confusion (#2390)

* DOC-9190 Scopes & Collections name length incorrect #2370

* [ray offiah] fixing the prometheus installation instructions (#2393)

* DOC-9588: Information on group correspondences for LDAP (#2392)

* [DOC-9611] Wrong output for OBJECT_INNER_VALUES (#2399)

* test_kroki_on_production (#2423)

* DOC-9198: Gradual Learning Progression (#2424)

  - DOC-9201: Move Learn and Manage after Develop
  - DOC-9202: Combine Tutorial and Guides into Develop

* Remove subqueries from description of JOIN how-to guide (#2428)

* Revert launch dialog image for 7.1

* DOC-9240 Remove query workbench tree results for 7.1

Co-authored-by: Ray <77050471+RayOffiah@users.noreply.github.com>
Co-authored-by: Richard Smedley <rgsmedley@gmail.com>
Co-authored-by: RekhaDS <rexshyam@gmail.com>
Co-authored-by: Justin Ashworth <justin.ashworth@couchbase.com>
Co-authored-by: Ed.E <edxtdev@gmail.com>
Co-authored-by: quickdraft <80592148+quickdraft@users.noreply.github.com>
Co-authored-by: Maria Shodunke <maria-robobug@users.noreply.github.com>
Co-authored-by: Tony Hillman <tonyjhillman@gmail.com>
Co-authored-by: Tony Hillman <tonyhillman@Tonys-MacBook-Pro-2.local>
Co-authored-by: Abhinav Dangeti <abhinav@couchbase.com>
Co-authored-by: Ray Offiah <ray.offiah@couchbase.com>
Co-authored-by: Nawazish Mohammad Khan <md.nawazish.khan@gmail.com>
Co-authored-by: Hakim <hakim.cassimally@couchbase.com>
Co-authored-by: Jon Strabala <54073900+jon-strabala@users.noreply.github.com>
  • Loading branch information
15 people committed Feb 7, 2022
1 parent d52237e commit b17796e
Show file tree
Hide file tree
Showing 495 changed files with 42,947 additions and 4,834 deletions.
358 changes: 199 additions & 159 deletions modules/ROOT/nav.adoc

Large diffs are not rendered by default.

Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
89 changes: 29 additions & 60 deletions modules/cloud/pages/couchbase-aws-marketplace.adoc
Expand Up @@ -18,53 +18,61 @@ Couchbase is available through AWS Marketplace with hourly pricing, or through a
If you don't have one, https://aws.amazon.com/[sign up^] for one before proceeding.
* You should review the xref:couchbase-cloud-deployment.adoc#aws-best-practices[best practices] for deploying Couchbase Server on AWS.

== Deploying Couchbase Enterprise
== Deploying Couchbase Server

IMPORTANT: The CloudFormation templates are provided as a starting point and may be customized as needed.
Note that additional post deployment setup may be required.

. Log in to your account on the https://aws.amazon.com/marketplace/[Amazon Web Services Marketplace^], search for [.in]`Couchbase` and select Couchbase Enterprise Edition.
Alternately, you can click https://aws.amazon.com/marketplace/pp/prodview-zw6dtnc7i75ai[here^] to go to the Couchbase Enterprise Edition product page directly.
. The Couchbase Enterprise product page provides a quick overview of the product offering and useful links.
Alternately, you can click https://aws.amazon.com/marketplace/pp/prodview-zy5g2wqmqdyzw[here^] to go to the Couchbase Server product page directly.
. The Couchbase Server product page provides a quick overview of the product offering and useful links.
Click [.ui]*Continue to Subscribe*.
+
image::aws/deploying/aws-marketplace-couchbase-ee.png[,570]

. On the Subscribe screen, accept the terms and conditions for this software.
. On the Subscribe to this software screen, accept the terms and conditions for this software.
+
image::aws/deploying/aws-marketplace-couchbase-terms-conditions.png[,570]
image::aws/deploying/aws-marketplace-couchbase-ee-subscription-public-terms.png[,570]

. Once your request is processed, you'll be able to proceed by clicking [.ui]*Continue to Configuration*.
+
image::aws/deploying/aws-marketplace-couchbase-ee-subscription-public-terms.png[,570]
image::aws/deploying/aws-marketplace-couchbase-terms-conditions.png[,570]

. Configure the software by selecting the how you wish to deploy the software, and providing information required to configure the deployment.
. Configure the software by selecting CloudFormation Template from the *Fulfillment option* drop down. You can also customize the Couchbase Server version and the region where the software will be deployed.
Then click [.ui]*Continue to Launch*.
+
image::aws/deploying/aws-marketplace-couchbase-ee-configure-5.png[,570]

. Review your configuration and then choose Launch CloudFormation to launch your configuration through the AWS CloudFormation console.
+
NOTE: These templates are provided as a starting point and may be customized as needed.
Note that additional post deployment setup may be required.
. Review your configuration and then choose Launch CloudFormation from the *Choose Action* drop down to launch your configuration through the AWS CloudFormation console.
+
image::aws/deploying/aws-marketplace-couchbase-ee-launch-action.png[,570]

. You will be redirected to the AWS CloudFormation Console where you must create a stack.
A stack is a group of related resources that you manage as a single unit.
Select the [.in]`Amazon S3 template URL` and then click [.ui]*Next*.

.. In the *Specify template* section, choose the template source as the [.in]`Amazon S3 URL` and then click [.ui]*Next*.
+
image::aws/deploying/aws-marketplace-couchbase-ee-create-stack-select-template.png[,570]

. Enter the stack name and parameter values.
You can choose to use the default values defined in the AWS CloudFormation template or edit them.
Then click [.ui]*Next*.
.. In the *Specify stack details page*
Enter the stack name
+
image::aws/deploying/aws-marketplace-couchbase-ee-stack-stackname.png[,570]

.. Enter the *Network Configuration/Access* parameters, specifically the VPC where you would like to deploy the software, list of subnets, CIDR range to permit ssh access to the EC2 instances where the software is installed and the key-value pair to access the EC2 instances.
+
image::aws/deploying/aws-marketplace-couchbase-ee-stack-stack-networkconfiguration.png[,570]

.. Enter the *Core Server Configuration* parameters. Other than specifying the database user name and password, you can choose to use the default values defined in the AWS CloudFormation template or edit them.
+
NOTE: The user name and password will be required to log in to the Couchbase Server Web Console later.
+
image::aws/deploying/aws-marketplace-couchbase-ee-create-stack-parameters.png[,570]
image::aws/deploying/aws-marketplace-couchbase-ee-stack-stack-coreinstanceconfiguration.png[,570]

. Optionally, if you plan to set up Couchbase Multi-Dimensional Scaling, you can customize the parameters in the *Multi-Dimension Scaling Configuration* section.

. Optionally, you can specify tags for resources in your stack and the required permissions.
. Then click [.ui]*Next*.

. Optionally, in the *Configure stack options* page, you can specify tags for resources and other options in your stack and the required permissions.
Click [.ui]*Next*.
+
image::aws/deploying/aws-marketplace-couchbase-ee-create-stack-options.png[,570]
Expand All @@ -73,7 +81,7 @@ image::aws/deploying/aws-marketplace-couchbase-ee-create-stack-options.png[,570]
+
image::aws/deploying/aws-marketplace-couchbase-ee-create-stack-review-options-ack.png[,570]

. The stack creation takes a short while to complete and the status is displayed on the screen.
. The stack creation takes about 10 minutes to complete and the status is displayed on the screen.
After the process is completed, you should see a [.out]`CREATE_COMPLETE` status.
+
image::aws/deploying/aws-marketplace-couchbase-ee-create-stack-complete.png[,570]
Expand All @@ -85,7 +93,7 @@ After the deployment is completed, you can explore the resources created from th

image::aws/logging-in/aws-console-ec2-dashboard.png[,570]

Click [.ui]*Running Instances* under Resources to view the running instances of Couchbase Server and Sync Gateway.
Click [.ui]*Instances(running)* under Resources to view the running instances of Couchbase Server.
You can select a particular instance to view details such as the instance ID, state, IPv4 Public IP, and so on.

image::aws/logging-in/aws-console-ec2-instances.png[,570]
Expand All @@ -96,7 +104,7 @@ image::aws/logging-in/aws-console-ec2-instances.png[,570]
image::aws/logging-in/aws-console-ec2-couchbase-server-instance-public-ip.png[,570]

.. Open a browser tab and enter the copied IPv4 Public IP along with port 8091 as [.path]_<ipv4-public-ip>:8091_ to open the Couchbase Server Web Console.
.. Enter the Administrator user name and password you configured when creating the stack to sign in.
.. Enter the database administrator user name and password you configured when creating the stack to sign in.
+
image::aws/logging-in/aws-couchbase-ee-login.png[,570]

Expand All @@ -107,43 +115,4 @@ image::aws/logging-in/aws-couchbase-web-console-dashboard.png[,570]
Click the [.ui]*Servers* tab to explore the sever nodes that have been created.
+
image::aws/logging-in/aws-couchbase-web-console-servers.png[,570]
. This step describes how to log in to the Sync Gateway Admin portal.
.. From the AWS EC2 console, select a running Couchbase Sync Gateway instance and copy the IPv4 Public IP.
+
image::aws/logging-in/aws-console-ec2-sync-gateway-instance-public-ip.png[,570]

.. Open a browser tab and enter the copied IPv4 Public IP along with port 4984 as [.path]_<ipv4-public-ip>:4984_.
This opens the interface for Couchbase Sync Gateway which is already setup and configured to connect to an empty bucket on the cluster.
+
image::aws/logging-in/aws-couchbase-sync-gateway-connection.png[,570]

.. Open another browser tab and enter [.path]_<ipv4-public-ip>:4984/_admin/_ to open the Couchbase Sync Gateway Admin Portal.
+
image::aws/logging-in/aws-couchbase-sync-gateway-admin-portal.png[,570]

[#scaling]
== Scaling Your Couchbase Cluster

This section describes how to scale up your cluster in three simple steps.

. Log in to the AWS EC2 Console and select [.ui]*Instances* in the left navigation to list all the available instances.
Select the Couchbase Server instance you wish to scale up.
+
image::aws/scaling/aws-ec2-network-interfaces-couchbase-server-instance.png[,570]

. On left navigation, select [.ui]*Auto Scaling Groups*.
+
image::aws/scaling/aws-ec2-couchbase-server-auto-scaling-options.png[,570]

. Edit the selected Auto Scaling Group and then [.ui]*Save*.
In the following screen captures, you'll see that the number of server instances has been updated from 4 to 8.
+
image::aws/scaling/aws-ec2-couchbase-server-auto-scaling-group-edit.png[,570]
+
image::aws/scaling/aws-ec2-couchbase-server-auto-scaling-group-save.png[,570]
+
image::aws/scaling/aws-ec2-couchbase-server-auto-scaling-group-updated.png[,570]

. On a different browser tab, you can log in to the Couchbase Server Web Console to see the additional server nodes that were added to your cluster.
+
image::aws/scaling/aws-couchbase-web-console-servers-after-scaling.png[,570]
12 changes: 10 additions & 2 deletions modules/cloud/pages/couchbase-cloud-deployment.adoc
Expand Up @@ -79,10 +79,10 @@ For the majority of deployments, `m4.xlarge` provides a good balance of price an
You should deploy nodes across all available Availability Zones and then create a Couchbase Server Group per Availability Zone.

.Storage
* EBS `gp2` and EBS `io1` are recommended.
* EBS `gp3` and EBS `io1` are recommended.
+
The persistence of EBS offers a significant advantage.
For most deployments, EBS `gp2` provides a good balance of performance and cost.
For most deployments, EBS `gp3` provides a good balance of performance and cost.
+
NOTE: It is not recommended to exceed 1 TB for data drives.
Large drives can lead to overly dense nodes that suffer from long rebuild times.
Expand All @@ -106,7 +106,15 @@ However, they make using an Auto Scaling group more difficult because nodes will
This configuration can be further secured by specifying CIDR blocks to whitelist XDCR and client connectivity.
It's also recommended to restrict access to intra-cluster communication ports to the security group.

* Use of Secret Manager is recommended for storage of Couchbase Server credentials.
Secret manager enables secure access for applications to https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieving-secrets.html[retrieve^] database credentials.
Secret manager also provides mechanisms for https://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html[rotating^] your secrets automatically.
Secret manager can also be configured to rotate secrets from within a https://aws.amazon.com/premiumsupport/knowledge-center/rotate-secrets-manager-secret-vpc/[private VPC^]
If Couchbase Server is deployed by the AWS Marketplace Cloud Formation Template, admin credentials will be stored in a Secret Manager Secret.

* Disk encryption is recommended, and is https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html[available for EBS disks^].
Disk encryption can be enabled account-wide by default and is recommended.
If Couchbase Server is deployed by the AWS Marketplace Cloud Formation Template, the data disk will be encrypted.

* If using Couchbase Sync Gateway, it's recommended that you secure the admin interface for access from `127.0.0.1` only.
This can be configured using the Sync Gateway xref:sync-gateway::config-properties.adoc[configuration file].
Expand Down
74 changes: 74 additions & 0 deletions modules/develop/pages/intro.adoc
@@ -0,0 +1,74 @@
= Developer's Intro
:page-role: tiles -toc
:description: This section contains tutorials, how-to guides, and information about Couchbase Services to help you develop applications.
:!sectids:
:page-aliases: concepts:application-development

// Pass through HTML styles for this page.

ifdef::basebackend-html[]
++++
<style type="text/css">
/* Extend heading across page width */
div.page-heading-title,
div.contributor-list-box,
div#preamble,
nav.pagination {
flex-basis: 100%;
}
</style>
++++
endif::[]

{description}
It also provides links to the documentation for software development kits and starter kits.

== Developer Tutorial

This tutorial provides an introductory worked example for developers, showing how to use a software development kit with a simple database.

* xref:tutorials:couchbase-tutorial-student-records.adoc[]

== Developer Guides

These how-to guides walk you through common tasks for Couchbase Server development, such as storing, retrieving, and querying documents.

* xref:guides:intro.adoc[Developer Guides]

== SDKs

Couchbase offers numerous software development kits (SDKs) that provide programmatic access to Couchbase Server.

* xref:home:ROOT:sdk.adoc[]

== Starter Kits

Starter kits are repositories containing example code to get you started with various development projects.

* xref:getting-started:starter-kits.adoc[]

== Query Service Information

The Query Service enables you to issue queries to extract data from Couchbase clusters.
You can also issue queries for defining indexes and data manipulation.

* xref:n1ql:query.adoc[]

== Search Service Information

The Search Service (Full Text Search or FTS) enables you to create and manage full-text indexes, and provides extensive capabilities for natural-language and geospatial queries.

* xref:fts:fts-introduction.adoc[]

== Eventing Service Information

The Eventing Service provides near real-time handling of changes to data.
It enables you to execute code either in response to mutations, or as scheduled by timers.

* xref:eventing:eventing-overview.adoc[]

== Analytics Service Information

The Analytics Service is a parallel data management capability for Couchbase Server, designed to run ad-hoc, analytical queries efficiently over many records.

* xref:analytics:introduction.adoc[Introduction to Analytics]
Binary file modified modules/fts/assets/images/fts-advanced-panel.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified modules/fts/assets/images/fts-type-mapping-for-collection.png
Expand Up @@ -33,5 +33,4 @@ curl -XPUT -H "Content-type:application/json" http://<username>:<password>@<ip>:
curl -XPUT -H "Content-type:application/json" http://<username>:<password>@<ip>:8094/api/managerOptions \-d '{"maxFeedsPerDCPAgent": "1"}'
----
+

NOTE: Ensure that you have enough memory quota.
Expand Up @@ -2,4 +2,8 @@

It Specifies the cluster level FTS configuration options. This environment variable allows you to specify the default value for the configuration option on the command line.

For example: export CBFT_ENV_OPTIONS=bleveMaxResultWindow=10000000’
== Example

----
export CBFT_ENV_OPTIONS=bleveMaxResultWindow=10000000’
----
Expand Up @@ -6,7 +6,7 @@ The `bleveMaxResultWindow` setting controls the maximum number of results a quer

== Example

[Source,JSON]
[source,console]
----
curl -XPUT -H "Content-type:application/json" http://username:password@<ip>:8094/api/managerOptions \-d '{
"bleveMaxResultWindow": "10000"
Expand Down
Expand Up @@ -6,10 +6,9 @@ Enabling this setting periodically adds more statistics whenever user runs the `

== Example

[Source,JSON]
[source,console]
----
curl -XPUT -H "Content-type:application/json" http://username:password@<ip>:8094/api/managerOptions \-d '{
"enableVerboseLogging": "true"
}
----

----
6 changes: 3 additions & 3 deletions modules/fts/pages/fts-advanced-settings-ftsMemoryQuota.adoc
Expand Up @@ -8,7 +8,7 @@ The FTS Search service recommends a minimum of 512 MB memory-resident ratio for

Using the manager option, users can control the FTS/Search service's memory quota at run time without a service reboot.

=== Spare Enough Memory for filesystem cache
== Spare enough memory for filesystem cache
Another important aspect while configuring the Search memory quota is to leave sufficient leeway RAM for the Operating System to manage the file system cache.

The Search’s internal text indexing library (bleve) uses memory mapping for the index files, so having enough RAM extra for the operating system helps in keeping the hot regions of index files in the file system cache memory.
Expand All @@ -18,9 +18,9 @@ The usual guideline is to set the Search memory quota to 60-70% of the available

Configuring enough RAM memory in the system and allocating sufficient Search quota memory is essential for optimal search performance.

== Example
=== Example

[Source,JSON]
[source,console]
----
curl -XPUT -H "Content-type:application/json" http://username:password@<ip>:8094/api/managerOptions \-d '{
"ftsMemoryQuota": "1024"
Expand Down
Expand Up @@ -8,7 +8,7 @@ You can get the maximum indexing throughput by setting the `maxFeedsPerDCPAgent`

== Example

[Source,JSON]
[source,console]
----
curl -XPUT -H "Content-type:application/json" http://username:password@<ip>:8094/api/managerOptions \-d '{
"maxFeedsPerDCPAgent": "10"
Expand Down
Expand Up @@ -6,7 +6,7 @@ The default limit value of this is *3*.

== Example

[Source,JSON]
[source,console]
----
curl -XPUT -H "Content-type:application/json" http://username:password@<ip>:8094/api/managerOptions \-d '{
"maxReplicasAllowed": "2"
Expand Down
Expand Up @@ -8,7 +8,7 @@ Every query for which the execution time is more than the value set in the `slow

== Example

[Source,JSON]
[source,console]
----
curl -XPUT -H "Content-type:application/json" http://username:password@<ip>:8094/api/managerOptions \-d '{
"slowQueryLogTimeout": "10"
Expand Down
26 changes: 17 additions & 9 deletions modules/fts/pages/fts-advanced.adoc
@@ -1,18 +1,20 @@

= Advanced Settings

Advanced settings can be specified by means of the *Advanced* panel.
When opened, this appears as follows:
Advanced settings can be specified in the *Advanced* panel. When opened, the Advanced panel appears as follows:

[#fts_advanced_panel]
image::fts-advanced-panel.png[,420,align=left]

The following, interactive fields are displayed:
The Advanced panel provides the following options:

== Default Type

The default type for documents in the selected bucket or scope and collection. The default value for this field is `default`.

== Default Analyzer

This is the default analyzer to be used.
The default value is `standard`.
This is the default analyzer to be used. The default value is `standard`.

The default analyzer is applicable to all the text fields across type mappings unless explicitly overridden.

Expand All @@ -28,12 +30,18 @@ The default value is `dateTimeOptional`.

== Default Field

Indexed fields need to have this option selected to support the- "include in _all", where all is the composite field.
Indexed fields need to have this option selected to support `include in _all`, where _all is the composite field.

The default value is `__all_`.
The default value is `_all`.

== Store Dynamic Fields

When checked, it ensures inclusion of field-content in returned results.
This option, when selected, ensures the inclusion of field content in returned results. Otherwise, the field content is not included in the result.

== Index Dynamic Fields

This option, When selected, ensures that the dynamic fields are indexed. Otherwise, the dynamic fields are not indexed.

== DocValues for Dynamic Fields

When unchecked, no such inclusion occurs.
This option, When selected, ensures that the values of the dynamic fields are included in the index. Otherwise, the dynamic field values are not included in the index.

0 comments on commit b17796e

Please sign in to comment.