Skip to content

Commit

Permalink
devguide examples
Browse files Browse the repository at this point in the history
  • Loading branch information
RichardSmedley committed Jan 10, 2025
1 parent 09da647 commit 8eaf867
Show file tree
Hide file tree
Showing 82 changed files with 113 additions and 36 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
149 changes: 113 additions & 36 deletions modules/hello-world/pages/overview.adoc
Original file line number Diff line number Diff line change
@@ -1,72 +1,145 @@
= Couchbase Java SDK 3.7
= Couchbase {name-sdk} {sdk_dot_minor}
:page-layout: landing-page-top-level-sdk
:page-role: tiles
:!sectids:

= Couchbase Java SDK 3.7

// Note to editors
//
// This page pulls in content from -sdk-common-
// and code samples from -example-dir-
//
// It can be seen built at wwww.
//
// See the antora.yml file for the {attributes}



= Couchbase {name-sdk} {sdk_dot_minor}

The Couchbase {name-sdk} allows {name_platform} applications to access a Couchbase cluster --
Capella or self-managed.
// -- other SDKs are available for Couchbase Lite (edge or mobile devices) and Capella Columnar (real-time analytics)

xref:hello-world:start-using-sdk.adoc[Quickstart Guide] |
xref:project-docs:sdk-release-notes.adoc[] |
{sdk-api-link}[{name-sdk} API Reference]


What's the point of a fast and scalable database if it's not easy to develop for?
Couchbase gives you the {name_platform} APIs to work with Capella, our managed solution, or self-managed options in your private Cloud or datacenter.


[{tabs}]
====
Data Ops (CRUD)::
+
--
[source,java]
----
include::devguide:example$scala/KvOperations.scala[indent=0,tag=upsert]
----
--
{sqlpp} Query (OLTP)::
+
--
[source,java]
----
include::devguide:example$scala/Queries.scala[tag=simple,indent=0]
----
--
Vector Search::
+
--
[source,java]
----
include::hello-world:example$Overview.java[tag=overview,indent=0]
include::devguide:example$scala/FTS.scala[tag=vector1,indent=0]
----
--
====


Couchbase is a large platform -- covering many services -- and Couchbase SDKs are not thin wrappers generated around a REST API, but well thought out interfaces to the platform that make it easier to design and maintain your client code,
and work with Couchbase in more natural ways for your platform.
Install the SDK, and explore in the way that works best for you.

.Installing the SDK via Maven
[source,xml,subs="normal, attributes"]
----
<dependencies>
<dependency>
<groupId>com.couchbase.client</groupId>
<artifactId>java-client</artifactId>
<version>{sdk_current_version}</version>
</dependency>
</dependencies>
----

The links below will take you where you want to go -- as will the navigation on the left-hand side of this page.
But if you don't know exactly where you need to go, try one of the following:

* Our xref:hello-world:start-using-sdk.adoc[Quickstart Guide] introduces the SDK with a quick install, and CRUD examples against the Data Service.
* Couchbase's familiar SQL-family query language and fuzzy search options (including vector search) are introduced on the xref:concept-docs:querying-your-data.adoc[] page.
* The {name-sdk} docs are, necessarily, just a sub-set {sdk-api-link}[{name-sdk} API Reference] -- and a complete reference of all APIs can be found there.
* For a fuller orientation, there is a xref:project-docs:metadoc-about-these-sdk-docs.adoc[guide to the {name-sdk} docs]

The Couchbase Java client allows applications to access a Couchbase cluster.
It offers synchronous APIs as well as reactive and asynchronous equivalents to maximize flexibility and performance. +

{empty} +

== icon:database[] Using Your Database

How-to guides to help you start your development journey with Couchbase and the Java SDK.
How-to guides to help you start your development journey with Couchbase and the {name-sdk}.

++++
<div class="card-row three-column-row">
<div class="card-row two-column-row">
++++

[.column]
.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[]
.Easy to Connect & Get Started
* xref:hello-world:start-using-sdk.adoc[Quickstart Guide]
* xref:hello-world:sample-application.adoc[]
* xref:hello-world:spring-data-sample-application.adoc[]
* xref:howtos:managing-connections.adoc[]
// * xref:hello-world:student-record-developer-tutorial.adoc[Beginners' Couchbase Tutorial]

[.column]
.Transactions
* xref:howtos:distributed-acid-transactions-from-the-sdk.adoc[]
* xref:concept-docs:transactions.adoc[]
.Search, Query, Analyze
* xref:howtos:sqlpp-queries-with-sdk.adoc[Query with a familiar, SQL-like language]
* xref:howtos:vector-searching-with-sdk.adoc[Vector Search for your AI app]
* xref:howtos:full-text-searching-with-sdk.adoc[Fuzzy Search with text and Geo data]
* xref:howtos:analytics-using-sdk.adoc[OLAP -- long running analytical queries]

// For Real-Time Analytics, see our xref:[Capella Columnar SDKs].

[.column]
.Working with Data
.Lightning Fast Data Service
* xref:howtos:kv-operations.adoc[]
* xref:howtos:subdocument-operations.adoc[]
* xref:howtos:analytics-using-sdk.adoc[]
* xref:howtos:encrypting-using-sdk.adoc[]
* xref:howtos:working-with-collections.adoc[Working with Collections]
* xref:howtos:distributed-acid-transactions-from-the-sdk.adoc[Multi-Document Distributed ACID Transactions]

[.column]
.Managing Couchbase
* xref:howtos:managing-connections.adoc[]
* xref:howtos:sdk-authentication.adoc[]
* xref:howtos:provisioning-cluster-resources.adoc[]
* xref:howtos:sdk-user-management-example.adoc[]

[.column]
.Errors & Diagnostics
.Observability & Error Handling
* xref:howtos:error-handling.adoc[]
* xref:howtos:collecting-information-and-logging.adoc[]
* xref:howtos:slow-operations-logging.adoc[]
* xref:howtos:health-check.adoc[]

++++
</div>
++++

////
== icon:graduation-cap[] Learn
Take a deep-dive into the SDK concept material and learn more about Couchbase.
++++
<div class="card-row three-column-row">
<div class="card-row two-column-row">
++++
[.column]
Expand All @@ -84,29 +157,33 @@ Take a deep-dive into the SDK concept material and learn more about Couchbase.
++++
</div>
++++
////

{empty} +

== icon:book[] Resources

Useful resources to help support your development experience with Couchbase and the Java SDK.
Useful resources to help support your development experience with Couchbase and the {name_platform} SDK.

++++
<div class="card-row three-column-row">
<div class="card-row two-column-row">
++++

[.column]
.Reference
* https://docs.couchbase.com/sdk-api/couchbase-java-client/[API Reference]
* {sdk-api-link}[API Reference^]
* xref:ref:client-settings.adoc[]
* xref:ref:error-codes.adoc[]
* xref:ref:glossary.adoc[Glossary]
* xref:ref:travel-app-data-model.adoc[]
* {sdk-gh-link}[SDK source code]
// * xref:ref:glossary.adoc[Glossary]
// * xref:ref:travel-app-data-model.adoc[]

[.column]
.Project Docs
.Deployment
* xref:project-docs:sdk-release-notes.adoc[]
* xref:project-docs:compatibility.adoc[Compatibility]
* https://docs-archive.couchbase.com/home/index.html[Older Versions Archive]
* xref:project-docs:migrating-sdk-code-to-3.n.adoc[]
// * https://docs-archive.couchbase.com/home/index.html[Older Versions Archive]
// ** xref:project-docs:migrating-sdk-code-to-3.n.adoc[]
* xref:project-docs:third-party-integrations.adoc[]
* xref:project-docs:sdk-full-installation.adoc[]

Expand Down

0 comments on commit 8eaf867

Please sign in to comment.