> For the complete documentation index, see [llms.txt](https://boxlang.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://boxlang.ortusbooks.com/boxlang-+-++/modules/bx-couchbase/built-in-functions/couchbasegetprovider.md).

# CouchbaseGetProvider

Get the Couchbase cache provider instance for direct access to provider methods.

## Syntax

```js
couchbaseGetProvider(cacheName)
```

## Parameters

| Parameter   | Type   | Required | Description                     |
| ----------- | ------ | -------- | ------------------------------- |
| `cacheName` | String | Yes      | Name of the cache configuration |

## Returns

Returns the `CouchbaseCache` provider instance with access to:

* Cache statistics and metadata
* Connection management
* Provider-specific methods

## Examples

### Basic Usage

```js
// Get provider instance
provider = couchbaseGetProvider("default");

// Access provider information
println("Provider name: #provider.getName()#");
println("Provider type: #provider.getType()#");
```

### Get Cache Statistics

```js
provider = couchbaseGetProvider("default");
stats = provider.getStatistics();

println("Cache hits: #stats.hits#");
println("Cache misses: #stats.misses#");
println("Hit rate: #stats.hitRate#%");
```

### Multiple Cache Configurations

```js
// Different caches for different purposes
sessionProvider = couchbaseGetProvider("sessions");
appProvider = couchbaseGetProvider("application");
vectorProvider = couchbaseGetProvider("vectors");

// Use them independently
sessionStats = sessionProvider.getStatistics();
appStats = appProvider.getStatistics();
vectorStats = vectorProvider.getStatistics();
```

## Notes

* The cache name must exist in your cache configuration
* Throws an error if the cache is not configured or not a Couchbase provider
* Provider instance is shared across requests (singleton)
* Useful for accessing provider-specific functionality not available through standard cache functions

## Related Functions

* [couchbaseGetCluster](/boxlang-+-++/modules/bx-couchbase/built-in-functions/couchbasegetcluster.md) - Get cluster connection
* [couchbaseGetBucket](/boxlang-+-++/modules/bx-couchbase/built-in-functions/couchbasegetbucket.md) - Get bucket instance
* [couchbaseGetCollection](/boxlang-+-++/modules/bx-couchbase/built-in-functions/couchbasegetcollection.md) - Get collection instance

## See Also

* [API Usage Guide](/boxlang-+-++/modules/bx-couchbase/api-usage.md)
* [Code Usage Patterns](/boxlang-+-++/modules/bx-couchbase/code-usage.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://boxlang.ortusbooks.com/boxlang-+-++/modules/bx-couchbase/built-in-functions/couchbasegetprovider.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.