Skip to content
Merged
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
49 changes: 38 additions & 11 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,26 @@ site:
# see https://confluence.issues.couchbase.com/wiki/spaces/DOCS/pages/2963243023/FAQ+how+does+the+top+nav+bar+work
nav_groups: |
[
{ "title": "Server", "startPage": "home::server.adoc", "components": ["server"] },
{ "title": "Server", "startPage": "home::server.adoc", "components": ["server", "enterprise-analytics"] },
{ "title": "Mobile / Edge", "startPage": "home::mobile.adoc", "components": ["couchbase-lite", "sync-gateway", "couchbase-edge-server"] },
{ "title": "Capella", "startPage": "home::cloud.adoc", "components": ["cloud", "columnar"] },
{ "title": "Capella", "startPage": "home::cloud.adoc", "components": ["cloud", "analytics"] },
{ "title": "Cloud-Native", "components": ["cloud-native-database"] },
{ "title": "Kubernetes Operator", "startPage": "operator::overview.adoc", "components": ["operator"] },
{ "title": "CMOS", "components": ["cmos"] },
{ "title": "Couchbase SDKs", "startPage": "home::sdk.adoc", "components": ["dotnet-sdk", "efcore-provider", "c-sdk", "cxx-sdk", "go-sdk", "java-sdk", "quarkus-extension", "kotlin-sdk", "nodejs-sdk", "php-sdk", "python-sdk", "ruby-sdk", "scala-sdk", "elasticsearch-connector", "kafka-connector", "spark-connector", "tableau-connector", "power-bi-connector", "superset-connector", "sdk-extensions"] },
{ "title": "Columnar SDKs", "startPage": "home::columnar-sdk.adoc", "components": ["*-columnar-sdk"] },
{ "title": "Develop", "startPage": "home::developer.adoc",
"subGroups": [
{
"title": "Operational SDKs",
"startPage": "home::sdk.adoc",
"components": ["develop", "dotnet-sdk", "efcore-provider", "c-sdk", "cxx-sdk", "go-sdk", "java-sdk", "quarkus-extension", "kotlin-sdk", "nodejs-sdk", "php-sdk", "python-sdk", "ruby-sdk", "scala-sdk", "elasticsearch-connector", "kafka-connector", "spark-connector", "tableau-connector", "power-bi-connector", "superset-connector", "sdk-extensions"]
},
{
"title": "Analytics SDKs",
"startPage": "home::analytics-sdk.adoc",
"components": ["*-analytics-sdk", "*-columnar-sdk"]
}
]
},
{ "title": "Tutorials", "startPage": "tutorials::index.adoc", "components": ["tutorials"] },
{ "title": "Contribute", "components": ["home", "styleguide", "ui-ux", "pendo"] }
]
Expand All @@ -62,6 +74,7 @@ content:
- url: .
branches: HEAD
start_path: home

- url: https://github.com/couchbaselabs/docs-style-guide
branches: main
start_paths: [styleguide, ui-ux, pendo]
Expand All @@ -81,8 +94,12 @@ content:
start_paths: [docs/public, docs/columnar]
- url: https://github.com/couchbase/docs-capella
branches: [main]

- url: https://github.com/couchbaselabs/docs-columnar
branches: [main]
branches:
- main # `analytics` component (Capella Analytics)
- release/2.0 # `enterprise-analytics` component (self-managed)
- legacy-columnar-component # `columnar` dummy component for sake of :page-aliases:

# Couchbase Autonomous Kubernetes Operator
############################
Expand Down Expand Up @@ -122,7 +139,7 @@ content:
branches: [release/1.0]
- url: https://github.com/couchbase/docs-connectors-talend

# Server related sections
# Server
############################

- url: https://github.com/couchbase/docs-analytics
Expand All @@ -134,8 +151,6 @@ content:
branches: [trinity, neo, 7.1.x-docs, cheshire-cat]
start_path: docs

# docs-server
############################
# NOTE docs-server is currently after other server repos so nav key wins

- url: https://github.com/couchbase/docs-server
Expand Down Expand Up @@ -184,7 +199,7 @@ content:
- url: https://github.com/couchbase/docs-sdk-extensions
branches: [main]

# Columnar SDKs
# Analytics SDKs (aka Columnar)
############################

- url: https://github.com/couchbase/docs-columnar-sdk-common
Expand All @@ -199,6 +214,18 @@ content:
- url: https://github.com/couchbase/docs-columnar-sdk-python
branches: [release/1.0]

- url: https://github.com/couchbase/docs-analytics-sdk-common
branches: [release/1.0]

- url: https://github.com/couchbase/docs-analytics-sdk-go
branches: [release/1.0]
- url: https://github.com/couchbase/docs-analytics-sdk-java
branches: [release/1.0]
- url: https://github.com/couchbase/docs-analytics-sdk-nodejs
branches: [release/1.0]
- url: https://github.com/couchbase/docs-analytics-sdk-python
branches: [release/1.0]

# Mobile
############################

Expand Down Expand Up @@ -259,7 +286,7 @@ asciidoc:
enterprise: https://www.couchbase.com/products/editions[ENTERPRISE EDITION]
community: https://www.couchbase.com/products/editions[COMMUNITY EDITION]
sqlpp: SQL++
sqlppc: SQL++ for Capella columnar
sqlppc: SQL++ for Capella Analytics
sqlppea: SQL++ for Enterprise Analytics
sqlpp_url: https://www.couchbase.com/products/n1ql
cbpp: Couchbase++
Expand All @@ -280,7 +307,7 @@ asciidoc:

ui:
bundle:
url: https://github.com/couchbase/docs-ui/releases/download/prod-210/ui-bundle.zip
url: https://github.com/couchbase/docs-ui/releases/download/prod-215/ui-bundle.zip
output:
dir: ./public
runtime:
Expand Down
2 changes: 1 addition & 1 deletion home/modules/ROOT/pages/analytics-sdk.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ include::partial$info-banner.adoc[]
// Capella Columnar is a standalone, cloud-only offering from Couchbase under the Capella family of products.
// It uses column storage, which gives speedier retrieval of data.

xref:analytics:intro:intro.adoc[Enterprise Analytics] is a self-managed, JSON-native NoSQL analytical database.
xref:enterprise-analytics:intro:intro.adoc[Enterprise Analytics] is a self-managed, JSON-native NoSQL analytical database.
It serves to unify data from diverse sources, allowing for the execution of complex analytical queries and the extraction of timely insights.

{empty} +
Expand Down
10 changes: 5 additions & 5 deletions home/modules/ROOT/pages/cloud.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,12 @@ Get set up with an account and deploy a free tier operational cluster.


[.card-box]
=== icon:rocket[] Get Started With Capella Columnar
=== icon:rocket[] Get Started With Capella Analytics

Create your account and follow our tutorial on how to load data into your columnar cluster.

* https://cloud.couchbase.com/sign-up[Sign Up^]
* xref:columnar:intro:intro.adoc[]
* xref:columnar:admin:prepare-project.adoc[]
* xref:columnar:intro:examples.adoc[]
* xref:columnar:query:workbench.adoc[]
* xref:analytics:intro:intro.adoc[]
* xref:analytics:admin:prepare-project.adoc[]
* xref:analytics:intro:examples.adoc[]
* xref:analytics:query:workbench.adoc[]
34 changes: 23 additions & 11 deletions home/modules/ROOT/pages/columnar-sdk.adoc
Original file line number Diff line number Diff line change
@@ -1,27 +1,39 @@
= Develop with Capella Columnar
= Develop with Capella Analytics
:page-layout: landing-page-top-level-sdk
:page-role: tiles
:page-rank: 75
:!sectids:

= Develop with Capella Columnar
= Develop with Capella Analytics

include::partial$info-banner.adoc[]

////
TIP box on analytics, after EA GA.
////
xref:analytics:intro:intro.adoc[Capella Analytics] is a real-time analytical database (RT-OLAP) for real time apps and operational intelligence.
Capella Analytics is a standalone, managed offering from Couchbase under the Capella family of products --
a self-managed xref:enterprise-analytics:intro:intro.adoc[Enterprise Analytics] product is also available.

TIP
.Which Analytics Service?
====
Capella Analytics and Enterprise Analytics are column-based real-time analytical databases.

Capella Analytics SDKs, also known as Columnar SDKs, are similar to the Enterprise Analytics SDKs.
They must be used to connect to the current Capella Analytics Service, as it presents a different connection interface, without Enterprise Analytics' load balancer.

To connect to self-managed Enterprise Analytics, use our xref:analytics-sdk.adoc[Enterprise Analytics SDKs].

xref:server:learn:services-and-indexes/services/analytics-service.adoc[CBAS (Couchbase Analytics Service)] is our classic OLAP available as part of self-managed Couchbase Server and Capella Operational.
Use the xref:sdk.adoc[operational SDKs] to develop for this service.
====

xref:columnar:intro:intro.adoc[Capella Columnar] is a real-time analytical database (RT-OLAP) for real time apps and operational intelligence.
Capella Columnar is a standalone, cloud-only offering from Couchbase under the Capella family of products.

== SDK APIs to work with Capella Analytics:

Columnar SDKs are developed from the ground-up and while they maintain some syntactic similarities with the xref:sdk.adoc[operational SDKs],
they are purpose built for Columnar's analytical use cases.
they are purpose built for Capella Analytics's real-time analytical use cases.
They support streaming APIs to handle large datasets, as well as the common features expected to be present in any modern database SDK --
such as connection management and robust error handling.

== SDK APIs to work with Capella Columnar:


[{tabs}]
====
Expand All @@ -38,7 +50,7 @@ Java::
--
xref:java-columnar-sdk:hello-world:overview.adoc[Java Columnar SDK Docs] |
xref:java-columnar-sdk:hello-world:start-using-sdk.adoc[Quickstart] |
https://docs.couchbase.com/sdk-api/columnar-java-client[Java API Reference]
https://docs.couchbase.com/sdk-api/couchbase-columnar-java-client[Java API Reference]
--

Node.js::
Expand Down
43 changes: 36 additions & 7 deletions home/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,12 @@ xref:cloud::index.adoc[Couchbase Capella]

{empty} +

.Capella Columnar (RT-OLAP)
.Capella Analytics (RT-OLAP)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is EA going to get added here too?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! Just looking at this with @zeba-shireen now 👍


Capella Columnar is a real-time analytical database (RT-OLAP) for real time apps and operational intelligence.
Capella Columnar is a standalone, cloud-only offering from Couchbase under the Capella family of products.
Capella Analytics is a real-time analytical database (RT-OLAP) for real time apps and operational intelligence.
Capella Analytics is a standalone, cloud-only offering from Couchbase under the Capella family of products.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it correct to call it cloud only, since it's functionally identical to EA?


xref:columnar:intro:intro.adoc[Capella Columnar]
xref:analytics:intro:intro.adoc[Capella Analytics]


[.column]
Expand All @@ -81,6 +81,14 @@ Explore Couchbase Server, a modern, distributed document database with all the d

xref:server.adoc[Couchbase Server]

{empty} +

.Enterprise Analytics (RT-OLAP)

Enterprise Analytics is a self-managed analytical database (RT-OLAP) for real time apps and operational intelligence.

xref:analytics:intro:intro.adoc[Capella Analytics]

[.column]
====== {empty}
.Couchbase Mobile
Expand Down Expand Up @@ -113,8 +121,10 @@ xref:couchbase-edge-server:introduction:intro.adoc[Couchbase Edge Server]
[.content]
Couchbase SDKs allow applications to access a Couchbase cluster and the big data Connectors enable data exchange with other platforms.

xref:home:ROOT:sdk.adoc[Developer Docs] |
xref:home:ROOT:columnar-sdk.adoc[Columnar SDKs]
xref:home:ROOT:developer.adoc[Developer Docs] |
xref:home:ROOT:sdk.adoc[Operational SDKs] |
xref:home:ROOT:analytics-sdk.adoc[Enterprise Analytics SDKs] |
xref:home:ROOT:columnar-sdk.adoc[Capella Analytics SDKs]

[.column]
====== {empty}
Expand Down Expand Up @@ -190,16 +200,25 @@ https://forums.couchbase.com/[Community]

a| xref:cloud::index.adoc[Couchbase Capella]

xref:columnar:intro:intro.adoc[Capella Columnar]
xref:analytics:intro:intro.adoc[Capella Analytics]




a| xref:server.adoc[Couchbase Server]

xref:enterprise-analytics:intro:intro.adoc[Enterprise Analytics]

xref:operator::overview.adoc[Couchbase Autonomous Operator]

xref:service-broker::index.adoc[Couchbase Service Broker]

xref:cmos::index.adoc[Couchbase Monitoring and Observability Stack]





a| xref:java-sdk:hello-world:overview.adoc[Couchbase Java SDK]

xref:scala-sdk:hello-world:overview.adoc[Couchbase Scala SDK]
Expand Down Expand Up @@ -228,6 +247,16 @@ xref:kafka-connector::quickstart.adoc[Couchbase Kafka Connector]

xref:spark-connector::getting-started.adoc[Couchbase Spark Connector]

xref:go-analytics-sdk:hello-world:overview.adoc[Go Analytics SDK]

xref:java-analytics-sdk:hello-world:overview.adoc[Java Analytics SDK]

xref:nodejs-analytics-sdk:hello-world:overview.adoc[Node.js Analytics SDK]

xref:python-analytics-sdk:hello-world:overview.adoc[Python Analytics SDK]

xref:go-columnar-sdk:hello-world:overview.adoc[Go Columnar SDK]

xref:java-columnar-sdk:hello-world:overview.adoc[Java Columnar SDK]

xref:nodejs-columnar-sdk:hello-world:overview.adoc[Node.js Columnar SDK]
Expand Down
35 changes: 16 additions & 19 deletions home/modules/ROOT/pages/sdk.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,13 @@ collection.reactive.upsert("document-key", json)
[TIP]
.Analytics SDKs
====
////
SDKs for xref:analytics:intro:intro.adoc[Enterprise Analytics] --
SDKs for xref:enterprise-analytics:intro:intro.adoc[Enterprise Analytics] --
Couchbase's analytical database (RT-OLAP) for real time apps and operational intelligence --
are xref:analytics-sdk.adoc[available] for the Go, Java, Node.js, and Python platforms.


SDKs for xref:columnar:intro:intro.adoc[Capella Analytics] are similar to the Enterprise Analytics SDKs.
SDKs for xref:analytics:intro:intro.adoc[Capella Analytics] are similar to the Enterprise Analytics SDKs.
They must be used to connect to the current Capella Analytics Service, as it presents a different connection interface, without Enterprise Analytics' load balancer.
They are xref:columnar-sdk.adoc[available] for the Go, Java, Node.js, and Python platforms.
////
SDKs for xref:columnar:intro:intro.adoc[Capella Columnar] are xref:columnar-sdk.adoc[available] for the Go, Java, Node.js, and Python platforms.
====

{empty} +
Expand Down Expand Up @@ -157,17 +153,17 @@ xref:sdk-extensions::distributed-acid-transactions.adoc[Distributed ACID Transac



////

{empty} +

== Enterprise Analytics SDKs

xref:enterprise-analytics:intro:intro.adoc[Capella Columnar] is an analytical database (RT-OLAP) for real time apps and operational intelligence.
xref:enterprise-analytics:intro:intro.adoc[Enterprise Analytics] is an analytical database (RT-OLAP) for real time apps and operational intelligence.
xref:analytics-sdk.adoc[Analytics SDKs] are tailored to the APIs offered by this service.

[#table_columnar_sdk,cols="42,40,60,50"]
[#table_analytics_sdk,cols="42,40,60,50"]
|===
| Columnar SDK | Documentation | Hello World Example | API Reference
| Analytics SDK | Documentation | Hello World Example | API Reference

| Go Analytics SDK
| xref:go-analytics-sdk:hello-world:overview.adoc[Docs]
Expand All @@ -189,15 +185,15 @@ xref:analytics-sdk.adoc[Analytics SDKs] are tailored to the APIs offered by this
| xref:python-analytics-sdk:hello-world:start-using-sdk.adoc[Python Getting Started]
| https://docs.couchbase.com/sdk-api/analytics-python-client/[Python Analytics API Reference]
|===
////



{empty} +

== Capella columnar SDKs
== Capella Analytics SDKs

xref:columnar:intro:intro.adoc[Capella Columnar] is an analytical database (RT-OLAP) for real time apps and operational intelligence.
xref:columnar-sdk.adoc[Columnar SDKs] are tailored to the APIs offered by this service.
xref:analytics:intro:intro.adoc[Capella Analytics] is an analytical database (RT-OLAP) for real time apps and operational intelligence.
xref:columnar-sdk.adoc[Columnar SDKs] for Capella Analytics are tailored to the APIs offered by this service.

[#table_columnar_sdk,cols="42,40,60,50"]
|===
Expand Down Expand Up @@ -247,23 +243,23 @@ xref:server:sdk:sdk-doctor.adoc[SDK doctor]

| Couchbase Lite Java Android
| xref:couchbase-lite:android:quickstart.adoc[Docs]
| http://docs.couchbase.com/mobile/2.8.0/couchbase-lite-android/[API Reference]
| http://docs.couchbase.com/mobile/3.2.0/couchbase-lite-android/[API Reference]

| Couchbase Lite C#
| xref:couchbase-lite:csharp:quickstart.adoc[Docs]
| http://docs.couchbase.com/mobile/2.8.0/couchbase-lite-net[API Reference]
| http://docs.couchbase.com/mobile/3.2.0/couchbase-lite-net[API Reference]

| Couchbase Lite Java
| xref:couchbase-lite:java:quickstart.adoc[Docs]
| http://docs.couchbase.com/mobile/2.8.0/couchbase-lite-java/index.html?[API Reference]
| http://docs.couchbase.com/mobile/3.2.0/couchbase-lite-java/index.html?[API Reference]

| Couchbase Lite Objective-C
| xref:couchbase-lite:objc:quickstart.adoc[Docs]
| http://docs.couchbase.com/mobile/2.8.0/couchbase-lite-objc[API Reference]
| http://docs.couchbase.com/mobile/3.2.0/couchbase-lite-objc[API Reference]

| Couchbase Lite Swift
| xref:couchbase-lite:swift:quickstart.adoc[Docs]
| http://docs.couchbase.com/mobile/2.8.0/couchbase-lite-swift[API Reference]
| http://docs.couchbase.com/mobile/3.2.0/couchbase-lite-swift[API Reference]

| Couchbase Lite JavaScript
| xref:couchbase-lite::javascript.adoc[Docs]
Expand Down Expand Up @@ -297,6 +293,7 @@ xref:server:sdk:sdk-doctor.adoc[SDK doctor]
* xref:spark-connector::getting-started.adoc[Get Started]
* xref:spark-connector::dev-workflow.adoc[Development Workflow]
* xref:spark-connector::java-api.adoc[Java API]
* xref:spark-connector::pyspark.adoc[PySpark]

[.column]
.ODBC and JDBC Drivers
Expand Down