oci-redis

library2.132.0jsnpmunverified

Oracle Cloud Infrastructure (OCI) Node.js/TypeScript SDK module for managing Redis Service resources. Version 2.132.0 supports all Redis CRUD operations including instances, clusters, configurations, and work requests. Part of the official OCI TypeScript SDK, it is updated monthly with new features and bug fixes. Differentiates from generic Redis clients by providing full OCI IAM integration, automatic request signing, and first-class TypeScript types. Requires an OCI account, API key pair, and appropriate policies.

database

npm install oci-redis

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · OCI-REDIS

oci-redis

databasejavascriptv2.132.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

RedisClient

✓ import { RedisClient } from 'oci-redis'

✗ const RedisClient = require('oci-redis').RedisClient

Use named import for ESM; CJS requires using .default or destructuring.

models

✓ import * as models from 'oci-redis/lib/models'

✗ const models = require('oci-redis/models')

Import models from 'oci-redis/lib/models' subpath; for CJS use require('oci-redis/lib/models').

requests

✓ import { CreateRedisClusterRequest } from 'oci-redis/lib/requests'

✗ import { CreateRedisClusterRequest } from 'oci-redis'

Request types are exported from 'oci-redis/lib/requests', not top-level.

DefaultRequestSigner

✓ import { DefaultRequestSigner } from 'oci-common'

✗ import { DefaultRequestSigner } from 'oci-redis'

Signer is provided by 'oci-common' package, not 'oci-redis'.

Region

✓ import { Region } from 'oci-common'

✗ import { Region } from 'oci-redis'

Region enum is part of 'oci-common'.

Initializes RedisClient using OCI config file auth, lists Redis clusters in a compartment.

import { RedisClient } from 'oci-redis'; import { Region } from 'oci-common'; import common = require('oci-common'); // CJS style for auth provider const provider = new common.ConfigFileAuthenticationDetailsProvider(); const client = new RedisClient({ authenticationDetailsProvider: provider, region: Region.US_PHOENIX_1 }); async function listClusters() { const listRequest = { compartmentId: process.env.COMPARTMENT_ID ?? '' }; const response = await client.listRedisClusters(listRequest); console.log('Clusters:', response.items); } listClusters().catch(console.error);

Debug

Known issues

breakingVersion 2.0.0 moved RedisClient from 'oci-redis' to 'oci-redis' but changed constructor signature to accept an object.

fix

Update to v2 constructor: new RedisClient({ authenticationDetailsProvider: ..., region: ... })

affects: <2.0.0

deprecatedThe 'RedisInstance' model was renamed to 'RedisCluster' in v2.0.0.

fix

Use 'RedisCluster' instead of 'RedisInstance'.

affects: <2.0.0

gotchaUsing CommonJS require without destructuring may return an object with default property.

fix

Use const { RedisClient } = require('oci-redis'); or import.
  For models: const models = require('oci-redis/lib/models');

affects: >=2.0.0

gotchaSome models require fields like compartmentId even if optional in API.

fix

Always provide required fields; check TypeScript types for exact requirements.

affects: >=2.0.0

gotchaThe SDK uses a custom HTTP client; proxy configuration is not supported out-of-the-box.

fix

Use environment variables HTTP_PROXY/HTTPS_PROXY or configure via authentication details provider.

affects: >=1.0.0

Errors

Common errors & fixes

TypeError: client.listRedisClusters is not a function

Using an older version where method was named 'listRedisInstances'.

fix

Upgrade to v2.132.0 and use listRedisClusters.

Error: Missing required parameter 'compartmentId'

compartmentId omitted in list request.

fix

Add compartmentId to the request object.

Module not found: Error: Can't resolve 'oci-redis'

Package not installed or import path incorrect.

fix

Run 'npm install oci-redis' and ensure import path is correct: 'oci-redis'.

Property 'items' does not exist on type 'ListRedisClustersResponse'

Using an outdated version where response structure differs.

fix

Upgrade to v2.132.0 and check that response.items is an array.

Upgrade

Version history

2.132.0latest on npm

Audit

Dependencies

oci-commonrequiredProvides core OCI SDK utilities, authentication, and HTTP client

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/oracle/oci-typescript-sdk ↗

packageoci-redis ↗

homepagehttps://github.com/oracle/oci-typescript-sdk#readme ↗