{"id":41662,"library":"oci-mysql","title":"OCI MySQL Node.js Client","description":"Official Oracle Cloud Infrastructure SDK for managing MySQL Database Service resources (DB systems, backups, channels, configurations). Current stable version is 2.132.0. Released as part of the oci-typescript-sdk monorepo, updated frequently alongside OCI API changes. Provides full TypeScript types and supports all MySQL service operations via OCI API. Differentiators: first-party Oracle SDK with comprehensive coverage of MySQL service lifecycle, authentication via API keys or instance principals, and integration with OCI IAM policies.","status":"active","version":"2.132.0","language":"javascript","source_language":"en","source_url":"https://github.com/oracle/oci-typescript-sdk","tags":["javascript","typescript"],"install":[{"cmd":"npm install oci-mysql","lang":"bash","label":"npm"},{"cmd":"yarn add oci-mysql","lang":"bash","label":"yarn"},{"cmd":"pnpm add oci-mysql","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Provides authentication, HTTP transport, and common types for all OCI SDK modules.","package":"oci-common","optional":false}],"imports":[{"note":"ESM-only SDK; use named import.","wrong":"const MysqlClient = require('oci-mysql').MysqlClient","symbol":"MysqlClient","correct":"import { MysqlClient } from 'oci-mysql'"},{"note":"All model types are under the 'models' namespace; do not import directly from package root.","wrong":"import { MysqlDbSystem } from 'oci-mysql'","symbol":"MysqlDbSystem","correct":"import { models } from 'oci-mysql'; const dbSystem: models.MysqlDbSystem = ..."},{"note":"Model types are exported from 'oci-mysql/lib/model' or via 'models' namespace.","wrong":"import { CreateDbSystemDetails } from 'oci-mysql'","symbol":"CreateDbSystemDetails","correct":"import { CreateDbSystemDetails } from 'oci-mysql/lib/model'"}],"quickstart":{"code":"import { MysqlClient, models, requests } from 'oci-mysql';\nimport { common } from 'oci-common';\n\nconst provider = new common.ConfigFileAuthenticationDetailsProvider();\nconst client = new MysqlClient({ authenticationDetailsProvider: provider });\n\nasync function listDbSystems() {\n  const compartmentId = process.env.COMPARTMENT_ID ?? '';\n  const request: requests.ListDbSystemsRequest = { compartmentId };\n  const response = await client.listDbSystems(request);\n  console.log('DB systems:', response.items);\n}\n\nlistDbSystems().catch(console.error);","lang":"typescript","description":"Shows how to authenticate using OCI config file and list MySQL DB systems in a compartment."},"warnings":[{"fix":"Use async iterables: for await (const page of client.listDbSystemsPaginators(listDbSystemsRequest)) { ... }","message":"Pagination methods changed: list* methods no longer return paginated responses automatically; use for-await-of or manual pagination.","severity":"breaking","affected_versions":">=1.5.0"},{"fix":"Set endpoint via client constructor: new MysqlClient({ authenticationDetailsProvider, endpoint: 'https://mysql.us-phoenix-1.oci.oraclecloud.com' })","message":"The global endpoint (e.g., 'https://mysql.us-phoenix-1.oci.oraclecloud.com') is deprecated; use regional endpoints or instance principal.","severity":"deprecated","affected_versions":">=2.0.0"},{"fix":"Ensure provider is initialized: const provider = new common.ConfigFileAuthenticationDetailsProvider();","message":"Authentication provider must be created before any client; common mistake is passing undefined provider.","severity":"gotcha","affected_versions":">=1.0.0"},{"fix":"Update imports: import { requests, responses } from 'oci-mysql';","message":"All request/response types moved to 'requests' and 'responses' namespaces in v2.","severity":"breaking","affected_versions":">=2.0.0"},{"fix":"Use ConfigFileAuthenticationDetailsProvider or ResourcePrincipalAuthenticationDetailsProvider.","message":"Use of 'oci-common' SDK v1 style authentication (SimpleAuthenticationDetailsProvider) is deprecated.","severity":"deprecated","affected_versions":">=2.0.0"}],"env_vars":null,"search_vec":"'2.132.0':25 'alongsid':38 'api':40,54,70 'authent':68 'backup':18 'chang':41 'channel':19 'client':4 'cloud':7 'comprehens':62 'configur':20 'coverag':63 'current':21 'databas':13 'db':16 'differenti':55 'first':57 'first-parti':56 'frequent':37 'full':43 'iam':79 'infrastructur':8 'instanc':73 'integr':76 'javascript':81 'key':71 'lifecycl':67 'manag':11 'monorepo':35 'mysql':2,12,49,65 'node.js':3 'oci':1,32,39,53,78 'oci-typescript-sdk':31 'offici':5 'oper':51 'oracl':6,59 'part':28 'parti':58 'polici':80 'princip':74 'provid':42 'releas':26 'resourc':15 'sdk':9,34,60 'servic':14,50,66 'stabl':22 'support':47 'system':17 'type':45 'typescript':33,44,82 'updat':36 'version':23 'via':52,69","created_at":"2026-06-04T18:53:30.094235+00:00","updated_at":"2026-06-04T18:53:30.094235+00:00","problems":[{"fix":"Ensure you import models from 'oci-mysql' and reference them as 'models.MysqlDbSystem'.","cause":"Client not initialized or incorrect import path for models.","error":"TypeError: Cannot read properties of undefined (reading 'mysql')"},{"fix":"Use ESM imports: import { common } from 'oci-common';","cause":"Using CommonJS require() for ESM-only package.","error":"oci-common is not a constructor"},{"fix":"Set endpoint to regional format: 'https://mysql.us-phoenix-1.oci.oraclecloud.com' (or use default if in that region).","cause":"Using deprecated global endpoint; must specify region-specific endpoint.","error":"Requested endpoint https://mysql.us-phoenix-1.oci.oraclecloud.com is not allowed"},{"fix":"Provide compartmentId as a string in the request object.","cause":"Omitted compartmentId in list request.","error":"Missing required parameter compartmentId"}],"ecosystem":"npm","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":"https://github.com/oracle/oci-typescript-sdk#readme","github":"https://github.com/oracle/oci-typescript-sdk","docs":null,"changelog":null,"pypi":null,"npm":"oci-mysql","openapi_spec":null,"status_page":null,"smithery":null,"categories":["database"],"base_url":null,"auth_type":null,"provenance":{"verified_status":null,"verified_at":null,"last_verified":"2026-06-04","next_check":"2026-09-02","install_tag":null}}