Details

    • Technical task
    • Resolution: Fixed
    • Major
    • None
    • None
    • None
    • DOC-2022-S24, DOC-2022-S25, DOC-2023-S1, DOC-2023-S2, DOC-2023-S3, DOC-2023-S4, DOC-2023-S5, DOC-2023-S6
    • 1

    Description

      N1QL in inline text:

      modules/concept-docs/pages/analytics-for-sdk-users.adoc::description: Parallel data management for complex queries over many records, using a familiar N1QL-like syntax.
      modules/concept-docs/pages/data-model.adoc:These data structures are stored as JSON documents in Couchbase, and can therefore be accessed using N1QL, Full Text Search, and normal key-value operations.
      modules/concept-docs/pages/documents.adoc:or xref:{version-server}@server:n1ql:n1ql-language-reference/update.adoc[N1QL UPDATE] to update documents based on specific query criteria:
      modules/concept-docs/pages/n1ql-query.adoc:For N1QL, the default consistency is `not_bounded`.
      modules/devguide/examples/nodejs/cloud.js:  // Perform a N1QL Query
      modules/devguide/examples/nodejs/n1ql-queries.js:  // Make a N1QL specific Query
      modules/devguide/examples/nodejs/query-create-index.js:// Make a N1QL specific Query to Create a Primary Index or Secondary Index
      modules/devguide/examples/nodejs/query-criteria.js:// Make a N1QL specific Query
      modules/devguide/examples/nodejs/query-named.js:// Make a N1QL specific Query
      modules/devguide/examples/nodejs/query-placeholders.js:// Make a N1QL specific Query
      modules/devguide/examples/nodejs/query-prepared.js:// Make a N1QL specific Query, telling Couchbase this will be a prepared statement
      modules/hello-world/examples/cloud.ts:  // Perform a N1QL Query
      modules/hello-world/examples/start-using.js:  // Perform a N1QL Query
      modules/hello-world/pages/sample-application.adoc:The https://github.com/couchbaselabs/{travel-sample-git-project}/blob/HEAD/{travel-sample-entrypoint}[{travel-sample-entrypoint}] file also contains the functions for handling users, registration, and N1QL queries.
      modules/hello-world/pages/start-using-sdk.adoc:* How to xref:sql-lookup[lookup documents] with the {sqlpp_url}[{sqlpp} (formerly N1QL)] query language.
      modules/hello-world/pages/start-using-sdk.adoc:* Or xref:howtos:n1ql-queries-with-sdk.adoc[Query] with our SQL-based N1QL language;
      modules/howtos/examples/error-handling.js:      // We have a N1QL error context, we can print out some useful information:
      modules/howtos/examples/transactions-example.ts:      // removing and replacing documents, performing N1QL queries, etc.
      modules/howtos/examples/transactions-example.ts:      // Performing a SELECT N1QL query against a scope:
      modules/howtos/examples/transactions-example.ts:  let bulkLoadStatement: string // a bulk-loading N1QL statement not provided here
      modules/howtos/examples/transactions-example.ts:  // let bulkLoadStatement: string // a bulk-loading N1QL statement not provided here
      modules/howtos/pages/analytics-using-sdk.adoc::description: Parallel data management for complex queries over many records, using a familiar N1QL-like syntax.
      modules/howtos/pages/analytics-using-sdk.adoc:To learn more about using N1QL for Analytics -- the first commercial implementation of SQL++ -- see our https://sqlplusplus-tutorial.couchbase.com/tutorial/#1[Tutorial Introduction to SQL++ for SQL users].
      modules/howtos/pages/distributed-acid-transactions-from-the-sdk.adoc:If you already use https://www.couchbase.com/products/n1ql[{sqlpp} (formerly N1QL)], then its use in transactions is very similar.
      modules/howtos/pages/encrypting-using-sdk.adoc:Alternatively, you can https://forums.couchbase.com/t/replacing-field-name-prefix/28786[rename the existing fields using a N1QL statement].
      modules/howtos/pages/encrypting-using-sdk.adoc:If you decide to rename the existing fields, make sure to do so _before_ writing any encrypted fields below the top level, otherwise it may be difficult to rename the nested fields using a generic N1QL statement.
      modules/howtos/pages/error-handling.adoc:A N1QL query either returns results or will throw an error with a `QueryErrorContext`, like so:
      modules/howtos/pages/kv-operations.adoc:Our xref:n1ql-queries-with-sdk.adoc[Query Engine] enables retrieval of information using the SQL-like syntax of N1QL.
      modules/howtos/pages/n1ql-queries-with-sdk.adoc::description: You can query for documents in Couchbase using the N1QL query language, a language based on SQL, but designed for structured and flexible JSON documents.
      modules/howtos/pages/n1ql-queries-with-sdk.adoc:Our query service uses N1QL, which will be fairly familiar to anyone who's used any dialect of SQL.
      modules/howtos/pages/n1ql-queries-with-sdk.adoc:xref:#additional-resources[Additional resources] for learning about N1QL are listed at the bottom of the page.
      modules/howtos/pages/n1ql-queries-with-sdk.adoc:Before you get started you may wish to check out the xref:{version-server}@server:n1ql:n1ql-language-reference/index.adoc[N1QL intro page], or just dive in with a query against our travel-sample data set.
      modules/howtos/pages/n1ql-queries-with-sdk.adoc:After familiarizing yourself with the basics on how the N1QL query language works and how to query it from the UI you can use it from the Node.js SDK.
      modules/howtos/pages/n1ql-queries-with-sdk.adoc:== CAS and N1QL
      modules/howtos/pages/n1ql-queries-with-sdk.adoc:If you are performing an operation with N1QL that requires CAS to be used, in combination with using CAS from regular KV operations for example,
      modules/howtos/pages/n1ql-queries-with-sdk.adoc://* A N1QL query using the default *Not Bounded* Scan Consistency will not wait for any indexes to finish updating before running the query and returning results, meaning that results are returned quickly, but the query will not return any documents that are yet to be indexed.
      modules/howtos/pages/n1ql-queries-with-sdk.adoc:NOTE: N1QL is not the only query option in Couchbase.
      modules/howtos/pages/n1ql-queries-with-sdk.adoc:// For a deeper dive into N1QL from the SDK, refer to our xref:concept:[N1QL SDK concept doc].
      modules/howtos/pages/n1ql-queries-with-sdk.adoc:The xref:{version-server}@server:n1ql:n1ql-language-reference/index.adoc[N1QL Language Reference] introduces up a complete guide to the N1QL language, including all of the latest additions.
      modules/howtos/pages/n1ql-queries-with-sdk.adoc:The http://query.pub.couchbase.com/tutorial/#1[N1QL interactive tutorial] is a good introduction to the basics of N1QL use.
      modules/howtos/pages/subdocument-operations.adoc:IMPORTANT: The sub-document operations described on this page are for _Key-Value_ requests only: they are not related to sub-document N1QL queries.
      modules/howtos/pages/subdocument-operations.adoc:(Sub-document N1QL queries are explained in the section xref:n1ql-queries-with-sdk.adoc[Querying with N1QL].)
      modules/howtos/pages/subdocument-operations.adoc:The _path_ follows N1QL syntax (see https://developer.couchbase.com/documentation/server/current/sdk/subdocument-operations.html#story-h2-12[below^],
      modules/howtos/pages/subdocument-operations.adoc:and xref:{version-server}@server:n1ql:n1ql-intro/queriesandresults.adoc[N1QL Queries and Results]).
      modules/howtos/pages/subdocument-operations.adoc:Path syntax largely follows N1QL conventions: A path is divided into components, with each component referencing a specific _level_ in a document hierarchy.
      modules/howtos/pages/subdocument-operations.adoc:a dot or brackets) it may be escaped using N1QL escapes.
      modules/howtos/pages/transcoders-nonjson.adoc:NOTE: It's important to note that the Couchbase Data Platform includes multiple components other than the Key-Value store -- including N1QL and its indexes, FTS, analytics, and eventing -- and these are optimized for JSON and will either ignore or provide limited functionality with non-JSON documents.
      modules/project-docs/pages/compatibility.adoc:| Scope-Level N1QL Queries & all Collections features
      modules/project-docs/pages/migrating-sdk-code-to-3.n.adoc:Compare this to a N1QL query:
      modules/project-docs/pages/migrating-sdk-code-to-3.n.adoc:Here is an example of the error context if a N1QL query is performed with an invalid syntax (i.e. `select 1= from`):
      modules/project-docs/pages/migrating-sdk-code-to-3.n.adoc:N1QL querying is now available at the `Cluster` level instead of the bucket level, because you can also write N1QL queries that span multiple buckets. Compare a simple N1QL query from SDK API 2 with its SDK API 3 equivalent:
      modules/project-docs/pages/migrating-sdk-code-to-3.n.adoc:Analytics querying, like N1QL, is also moved to the `Cluster` level: it is now accessible through the `Cluster.analyticsQuery` method.
      modules/project-docs/pages/migrating-sdk-code-to-3.n.adoc:Also, creating a N1QL index now lives in the `queryindexmanager`, which is accessible through the `cluster`.
      modules/project-docs/pages/sdk-release-notes.adoc:Fixed N1QL parameter options parsing.
      modules/howtos/pages/analytics-using-sdk.adoc:To learn more about using N1QL for Analytics -- the first commercial implementation of SQL++ -- see our https://sqlplusplus-tutorial.couchbase.com/tutorial/#1[Tutorial Introduction to SQL++ for SQL users].
      modules/howtos/pages/n1ql-queries-with-sdk.adoc:// SQL++ / Analytics.

      Use this command to update [source,n1ql] to [source,sqlpp]:
      Note, this is for Mac, you may need to change the command slightly on other systems.

       git grep -l "source,n1ql" | xargs sed -i '' -e 's/source,n1ql/source,sqlpp/g'

      Attachments

        Issue Links

          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              tom.rosewell Tom Rosewell (Inactive)
              maria.shodunke Maria Shodunke (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There are no open Gerrit changes

                  PagerDuty