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/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:= Querying with N1QL
|
modules/concept-docs/pages/n1ql-query.adoc::nav-title: Querying with N1QL
|
modules/concept-docs/pages/n1ql-query.adoc:* A N1QL query using the default `NotBounded` 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/concept-docs/pages/n1ql-query.adoc:For N1QL, the default consistency is `not_bounded`. |
modules/hello-world/pages/sample-application.adoc:The https://github.com/couchbaselabs/{travel-sample-git-project}/tree/HEAD/app[`app` directory] contains the various components, classes and functions for handling users, registration, and N1QL queries. |
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:Here we're fetching rows converted into `JsonObject`, but as with N1QL there's many more options available. |
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/concurrent-async-apis.adoc:The most important thing to consider is when streaming back large queries from N1QL, Full Text Search, and Analytics.
|
modules/howtos/pages/error-handling.adoc:A N1QL query either returns results or `QueryError`, like so:
|
modules/howtos/pages/kv-operations.adoc:N1QL can also be used to perform many single-document operations, but we very strongly recommend using the key-value API for this instead. It can be much more efficient as the request can go directly to the correct node, there's no query parsing overhead, and it's over the highly optimized memcached binary protocol. |
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:(Note that we won't be covering the N1QL language itself in any detail here, but if you're familiar with SQL you'll see it's very similar.) |
modules/howtos/pages/n1ql-queries-with-sdk.adoc:The Scala SDK returns `Try` rather than throwing exceptions, to allow you to handle errors in a functional way. A `Try` can either be a `Success(QueryResult)` if the N1QL statement was successfully executed, or `Failure(Throwable)` if something went wrong. It can be pattern matched on like this: |
modules/howtos/pages/n1ql-queries-with-sdk.adoc:The Scala SDK supports returning N1QL results directly as Scala case classes. |
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 <<Path syntax,N1QL syntax>>.
|
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/howtos/partials/n1ql-additional-resources.adoc:NOTE: N1QL is not the only query option in Couchbase.
|
modules/howtos/partials/n1ql-additional-resources.adoc:The http://query.pub.couchbase.com/tutorial/#1[N1QL interactive tutorial] is a good introduction to the basics of N1QL use. |
modules/howtos/partials/n1ql-intro.adoc: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/partials/n1ql-intro.adoc:Our query service uses N1QL, which will be fairly familiar to anyone who's used any dialect of SQL.
|
modules/howtos/partials/n1ql-intro.adoc:<<Additional Resources>> for learning about N1QL are listed at the bottom of the page. |
modules/howtos/partials/n1ql-intro.adoc:Before you get started you may wish to checkout the xref:6.5@server:n1ql:n1ql-language-reference/index.adoc[N1QL intro page]. |
modules/howtos/partials/n1ql-intro.adoc:.N1QL Compared to Key-Value
|
modules/howtos/partials/n1ql-intro.adoc:N1QL is excellent for performing queries against multiple documents, but if you only need to access or mutate a single document and you know its unique ID, it will be |
modules/howtos/partials/n1ql-scan-consistency.adoc:* A N1QL query using the default `NotBounded` 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/project-docs/pages/compatibility.adoc:| Scope-Level N1QL Queries & all Collections features
|
modules/project-docs/pages/sdk-release-notes.adoc:Added N1QL support for collections, via new `Scope.query` method. |
modules/ref/pages/client-settings.adoc:Mutation tokens allow enhanced durability requirements as well as advanced N1QL querying capabilities.
|
modules/ref/pages/client-settings.adoc:The Query timeout is used on all N1QL query operations if not overridden by a custom timeout. |
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]. |
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' |