Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
190 changes: 190 additions & 0 deletions modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,192 @@
* xref:hello-world:overview.adoc[Couchbase {name_platform} SDK Overview]

* xref:hello-world:start-using-sdk.adoc[Hello World]
** xref:hello-world:sample-application.adoc[]
** xref:hello-world:student-record-developer-tutorial.adoc[Student Record Tutorial]
** xref:howtos:managing-connections.adoc[Connecting to Your Database]
*** xref:howtos:sdk-authentication.adoc[Authentication & Authorization]
*** xref:howtos:troubleshooting-cloud-connections.adoc[Troubleshooting Cloud Connections]

* xref:concept-docs:data-durability-acid-transactions.adoc[Data Modelling, Durability, and Consistency]
** xref:howtos:kv-operations.adoc[]
*** xref:howtos:caching-example.adoc
** xref:howtos:concurrent-document-mutations.adoc[]
** xref:howtos:subdocument-operations.adoc[]
** xref:concept-docs:data-model.adoc[]
*** xref:concept-docs:documents.adoc[]
// *** xref:concept-docs:collections.adoc[]
*** xref:howtos:json.adoc[Choosing a JSON Library]
// only Java and Scala have ^
// Scala's we keep - Java's turns into the concept??
*** xref:concept-docs:subdocument-operations.adoc[Sub-Documents]
*** xref:concept-docs:nonjson.adoc[]
*** xref:howtos:transcoders-nonjson.adoc[Transcoders & Non-JSON Documents]
*** xref:concept-docs:xattr.adoc[XATTR & Virtual XATTR]
** xref:howtos:encrypting-using-sdk.adoc[Encrypting Your Data]
*** xref:concept-docs:encryption.adoc[Understanding Field Level Encryption]
** xref:concept-docs:compression.adoc[]

* xref:concept-docs:querying-your-data.adoc[]
** xref:howtos:sqlpp-queries-with-sdk.adoc[]
*** xref:concept-docs:n1ql-query.adoc[Understanding {sqlpp} Queries]
** xref:howtos:vector-searching-with-sdk.adoc[]
** xref:concept-docs:full-text-search-overview.adoc[Understanding Search]
*** xref:howtos:full-text-searching-with-sdk.adoc[Using the Search Service]
** xref:howtos:analytics-using-sdk.adoc[]

* xref:howtos:distributed-acid-transactions-from-the-sdk.adoc[Distributed ACID Transactions]
** xref:howtos:transactions-single-query.adoc[]
** xref:howtos:transactions-tracing.adoc[]
** xref:concept-docs:transactions.adoc[]
*** xref:concept-docs:transactions-cleanup.adoc[]
*** xref:concept-docs:transactions-error-handling.adoc[]

* xref:concept-docs:durability-replication-failure-considerations.adoc[]
** xref:howtos:collecting-information-and-logging.adoc[]
** xref:howtos:health-check.adoc[Using Health Check]
** xref:concept-docs:response-time-observability.adoc[Observability]
*** xref:howtos:slow-operations-logging.adoc[]
*** xref:howtos:observability-metrics.adoc[]
*** xref:howtos:observability-orphan-logger.adoc[]
*** xref:howtos:observability-tracing.adoc[]

* xref:concept-docs:best-practices.adoc[]
** xref:howtos:concurrent-async-apis.adoc[Async & Reactive APIs]
** xref:howtos:error-handling.adoc[]
// ** xref:howtos:unit-testing.adoc[]

* xref:concept-docs:management-api.adoc[Managing Couchbase]
** xref:howtos:provisioning-cluster-resources.adoc[]
** xref:howtos:sdk-user-management-example.adoc[Managing Users]

* xref:project-docs:deployment.adoc[SDK Deployment]
** xref:project-docs:sdk-release-notes.adoc[Release Notes]
*** https://docs-archive.couchbase.com/home/index.html[Older Versions Archive^]
** xref:project-docs:compatibility.adoc[]
*** xref:project-docs:migrating-sdk-code-to-3.n.adoc[]
*** xref:project-docs:distributed-acid-transactions-migration-guide.adoc[]
*** xref:project-docs:third-party-integrations.adoc[]
** xref:project-docs:sdk-full-installation.adoc[]
*** xref:hello-world:platform-help.adoc[]
** xref:project-docs:get-involved.adoc[]
*** xref:project-docs:sdk-licenses.adoc[]
*** xref:home:contribute:index.adoc[Improve the Docs]

* xref:ref:index.adoc[]
** https://docs.couchbase.com/sdk-api/couchbase-python-client[API Reference^]
** https://github.com/couchbase/couchbase-python-client[Python SDK source code^]
** xref:ref:client-settings.adoc[]
** xref:ref:error-codes.adoc[]
** xref:ref:glossary.adoc[Glossary]
** xref:ref:travel-app-data-model.adoc[]
** xref:project-docs:metadoc-about-these-sdk-docs.adoc[About These Docs]









////
.Getting Started
* xref:hello-world:start-using-sdk.adoc[]
* xref:howtos:kv-operations.adoc[]
* xref:howtos:n1ql-queries-with-sdk.adoc[]
* xref:howtos:full-text-searching-with-sdk.adoc[]
* xref:hello-world:sample-application.adoc[]
* xref:hello-world:spring-data-sample-application.adoc[]

.Transactions
* xref:howtos:distributed-acid-transactions-from-the-sdk.adoc[]
** xref:howtos:transactions-single-query.adoc[]
** xref:howtos:transactions-tracing.adoc[]
* xref:concept-docs:transactions.adoc[]
** xref:concept-docs:transactions-cleanup.adoc[]
** xref:concept-docs:transactions-error-handling.adoc[]

.Further Data Ops
* xref:howtos:json.adoc[]
* xref:howtos:subdocument-operations.adoc[]
// ** xref:howtos:sdk-xattr-example.adoc[Extended Attributes]
* xref:howtos:analytics-using-sdk.adoc[]
// ** xref:howtos:advanced-analytics-querying.adoc[Advanced Analytics Querying]
* xref:howtos:view-queries-with-sdk.adoc[]
* xref:howtos:concurrent-async-apis.adoc[Async & Reactive APIs]
* xref:howtos:concurrent-document-mutations.adoc[]
* xref:howtos:encrypting-using-sdk.adoc[]
* xref:howtos:transcoders-nonjson.adoc[Transcoders & Non-JSON Documents]

.Managing Couchbase
* xref:howtos:managing-connections.adoc[]
** xref:howtos:sdk-authentication.adoc[]
** xref:howtos:troubleshooting-cloud-connections.adoc[Troubleshooting Cloud Connections]
* xref:howtos:provisioning-cluster-resources.adoc[]
** xref:howtos:sdk-user-management-example.adoc[]

.Errors & Diagnostics
* xref:howtos:error-handling.adoc[]
* xref:howtos:collecting-information-and-logging.adoc[]
* xref:howtos:health-check.adoc[]
* Observability
** xref:howtos:slow-operations-logging.adoc[]
** xref:howtos:observability-metrics.adoc[]
** xref:howtos:observability-orphan-logger.adoc[]
** xref:howtos:observability-tracing.adoc[]

.Learn
* xref:concept-docs:concepts.adoc[]
* xref:concept-docs:buckets-and-clusters.adoc[Buckets & Clusters]
* xref:concept-docs:collections.adoc[Collections & Scopes]
* xref:concept-docs:compression.adoc[]
* xref:concept-docs:data-model.adoc[]
** xref:concept-docs:documents.adoc[]
** xref:concept-docs:nonjson.adoc[]
** xref:concept-docs:subdocument-operations.adoc[Sub-Documents]
** xref:concept-docs:xattr.adoc[XATTR & Virtual XATTR]
* xref:concept-docs:errors.adoc[Errors & Diagnostics]
** xref:concept-docs:health-check.adoc[]
** xref:concept-docs:response-time-observability.adoc[]
* xref:concept-docs:durability-replication-failure-considerations.adoc[]
* xref:concept-docs:encryption.adoc[Field Level Encryption]
* xref:concept-docs:data-services.adoc[Service Selection]
** xref:concept-docs:analytics-for-sdk-users.adoc[]
** xref:concept-docs:understanding-views.adoc[Views]
** xref:concept-docs:n1ql-query.adoc[]
** xref:concept-docs:full-text-search-overview.adoc[Search]
* xref:concept-docs:sdk-user-management-overview.adoc[User Management]
** xref:concept-docs:certificate-based-authentication.adoc[Cert Auth]
** xref:concept-docs:rbac.adoc[RBAC]

.References
* https://docs.couchbase.com/sdk-api/couchbase-java-client[API Reference]
* https://docs.couchbase.com/sdk-api/couchbase-core-io/[JVM Core IO API]
* https://docs.couchbase.com/sdk-api/couchbase-transactions-java/index.html?overview-summary.html[Transactions API Reference]
* xref:ref:client-settings.adoc[]
// * xref:ref:data-structures[Data Structures]
* xref:ref:error-codes.adoc[]
* xref:ref:glossary.adoc[Glossary]
* xref:ref:travel-app-data-model.adoc[]

.Project Docs
* xref:project-docs:sdk-release-notes.adoc[SDK Release Notes]
* xref:project-docs:compatibility.adoc[]
** xref:project-docs:migrating-sdk-code-to-3.n.adoc[]
*** xref:howtos:working-with-collections.adoc[Working with Collections]
** xref:project-docs:distributed-acid-transactions-migration-guide.adoc[]
** xref:project-docs:third-party-integrations.adoc[]
* xref:project-docs:sdk-full-installation.adoc[]
// ** xref:hello-world:platform-help.adoc[]
* https://docs-archive.couchbase.com/home/index.html[Older Versions Archive]
* xref:project-docs:sdk-licenses.adoc[]
* xref:project-docs:get-involved.adoc[]
** https://docs.couchbase.com/home/contribute/index.html[Improve the Docs]
* xref:project-docs:metadoc-about-these-sdk-docs.adoc[About These Docs]
////


////
.Couchbase Python SDK

.Getting Started
Expand Down Expand Up @@ -91,3 +280,4 @@
* xref:project-docs:get-involved.adoc[Get involved]
** https://docs.couchbase.com/home/contribute/index.html[Improve the Docs]
* xref:project-docs:metadoc-about-these-sdk-docs.adoc[About These Docs]
////
Loading
Loading