Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

Create a Search Index with the Quick Editor

  • how-to
    +
    Use the Quick Index editor in Couchbase Server’s Web Console to create a Search index.

    The Quick Index editor lets you select the fields that you want to add to a Search index with a document in your database.

    Prerequisites

    • You have the Search Service enabled on a node in your database.

    • You have a bucket with scopes and collections in your database.

    • Your user account has the Search Admin role for the bucket where you want to create the index.

    • You’ve logged in to the Couchbase Server Web Console.

    Procedure

    To use the Couchbase Server Web Console’s Quick Editor to create a Search index:

    1. Go to Search.

    2. Click Quick Index.

    3. In the Index Name field, enter a name for the index.

    4. In the first Keyspace list, select the bucket where you want to create the index.

    5. In the second Keyspace list, select the scope where you want to create the index.

    6. In the third Keyspace list, select the collection where you want to create the index.

    7. In the Select Fields box, click a field in the document that you want to add to the index.

    8. In the Type list, select the field’s data type.

      For more information about the available data types, see Field Data Types.

    9. Set the field’s options.

      For more information about the available field options, see Quick Index Field Options.

    10. Click Add.

    11. (Optional) Repeat the previous steps for each field you want to add to the Search index.

    12. Click Create Index.

    Next Steps

    You can customize your index with the standard Search index editor to improve your Search index’s performance and the quality of your search results.

    To run a search and test the contents of your Search index, see Run A Simple Search with the Web Console or Run a Simple Search with the REST API and curl/HTTP.