@eliware/elera-client
v15.0.0
Published
Application-facing Elera client for managed MySQL/MariaDB routing, failover, lifecycle, and telemetry
Maintainers
Readme
@eliware/elera-client

Application-facing Elera client for managed MySQL/MariaDB routing, failover, lifecycle, and telemetry
Table of Contents
- Features
- Requirements
- Setup
- Usage
- Development
- Testing
- Troubleshooting
- Security
- API
- Packaging
- Examples
- Support
- Links
- License
Features
Create a managed MySQL or MariaDB client that gets database routes and credentials from the Elera API.
Read the user guides, examples, and specifications.
Requirements
Use Node.js 26 or later in a native ESM project. CommonJS require() is not supported.
Setup
Install the package in your application:
npm install @eliware/elera-clientUsage
Set ELERA_API_URL to https://elera.example.test and ELERA_API_TOKEN to replace-with-application-token. Read the usage guide for setup and query examples. Read the release notes for package changes.
import { createDb } from "@eliware/elera-client";
const db = await createDb();
try {
const [rows] = await db.query("SELECT 1 AS connected");
console.log(rows);
} finally {
await db.end();
}Development
Run npm ci from the repository root. Read the specifications index for repository requirements and the documentation index for user guides.
Testing
Run npm test for aggregate validation. Run npm run typecheck, npm run check, or npm run lint for focused checks.
Troubleshooting
Read the troubleshooting guide for setup and query failures.
Security
Use an application token. Keep credentials out of source control, logs, and URLs.
API
The package root exports createDb and TypeScript types. Read the public API guide for options and client methods.
Packaging
The files field in package.json lists src/, docs/, README.md, AGENTS.md, LICENSE, RELEASE_NOTES.md, examples/, specs/, and .env.example for npm packaging.
Use numeric MAJOR.MINOR.PATCH versions and a v<version> tag for each release. The npm workflow starts when you push a tag. Run npm run pack to check package contents. Follow approved Eliware Operations procedures before publication.
Examples
Run node examples/basic.mjs to see the managed client. Read example guidance for prerequisites and expected results.
Support
For help, questions, or to chat with the author and community, visit:



