@ogs-gmbh/lexora-postgres-adapter

v1.0.0

Published

6 days ago

High-performance PostgreSQL adapter for Lexora - Seamlessly manage multi-language translations with enterprise-grade database storage, scoped namespaces, and flexible queries

Downloads

114

We're OGS, check out our work on github.com/ogs-gmbh

Postgres Adapter for Lexora

High-performance PostgreSQL adapter for Lexora - Seamlessly manage multi-language translations with enterprise-grade database storage, scoped namespaces, and flexible queries

Preview

Database-Backed Translation
Store and manage your internationalization data directly in PostgreSQL with full ACID compliance and data integrity.
Scoped Namespaces
Organize translations into logical scopes for better structure and efficient queries across large-scale applications.
High Performance
Optimized SQL queries with support for custom statements and the powerful postgres.js library for maximum throughput.
Flexible Configuration
Seamless integration with Lexora - use connection strings or advanced postgres.js options with custom query support.

Getting Started

[!IMPORTANT] We're offering an extensive API-Reference covered with in-depth usage examples of this project.

To get a starting point, simply refer to our documentation at ogs-gmbh.github.io/lexora-postgres-adapter.

Prerequisites

Node.js version 18 or higher
A package manager: e.g. npm, pnpm, ...

Installation

Using npm:

$ npm install @ogs-gmbh/lexora-postgres-adapter

Using yarn:

$ pnpm add @ogs-gmbh/lexora-postgres-adapter

Using pnpm:

$ pnpm add @ogs-gmbh/lexora-postgres-adapter

Using bun:

$ bun add @ogs-gmbh/lexora-postgres-adapter

Usage

lexora-adapter-postgres uses postgres.js under the hood. Here is a simple example integration for lexora. For a deeper understanding, checkout our reference.

import { getTranslations } from "@ogs-gmbh/lexora/server";
import { LexoraProvider } from "@ogs-gmbh/lexora/client";
import { postgresAdapter } from "@ogs-gmbh/lexora-postgres-adapter";

function RootLayout() {
  const translations = await getTranslations({
    locale: "de",
    autoMigrations: true,
    adapters: [postgresAdapter("postgres://admin:[email protected]:5432/default")]
  });

  return (
    <html>
      <body>
        <LexoraProvider data={translations}>{children}</LexoraProvider>
      </body>
    </html>
  );
}

export default RootLayout;

License

The MIT License (MIT) - Please have a look at the LICENSE file for more details.

Contributing

Contributions are always welcome and greatly appreciated. Whether you want to report a bug, suggest a new feature, or improve the documentation, your input helps make the project better for everyone.

Feel free to submit a pull request, issue or feature request.

Issues and Feature Requests

Reporting an issue or creating a feature request is made by creating a new issue on this repository.

You can create a new issue or feature request here.

Pull Requests

GitHub offers a solid guideline for contributing to open source projects through pull requests, covering key practices. These best practices provide a reliable starting point for making effective contributions.

You can find the guidelines here.

Code Of Conduct

We are committed to keeping a welcoming, inclusive, and respectful community for everyone. To help us achieve this, we kindly ask that you adhere to our Code of Conduct.

Disclaimer

All trademarks and registered trademarks mentioned are property of their respective owners and are used for identification purposes only. Use of these names does not imply endorsement or affiliation.

This project is a trademark of OGS Gesellschaft für Datenverarbeitung und Systemberatung mbH. The License does not grant rights to use the trademark without permission.

Gesellschaft für Datenverarbeitung und Systemberatung mbH

Imprint | Contact | Careers