@fortress-js/node/README.md

The Fortress Backend SDK

# Fortress Javascript Backend SDK

Welcome to the Fortress Javascript Backend SDK. This SDK provides a way for you to leverage the power of the Fortress platform in your Ruby applications.

## Installation

You can install the SDK using Gem. Simply run the following command:

```bash
npm install @fortress-js/node
```

## Quick Start

Here is a quick example to get you started with the SDK:

```typescript
import { Fortress } from "@fortress-js/node";

// Initialize the client
const client = new Fortress("apiKey", "organizationId");

// Create a new tenant
await client.createTenant("tenant_name", "alias");

// Connect to the tenant
const conn = await client.connectTenant("tenant_name");

conn.query("CREATE TABLE users (id SERIAL PRIMARY KEY, name VARCHAR(50))");
conn.query("INSERT INTO users (name) VALUES ('Alice')");
conn.query("SELECT * FROM users", (result) => {
  result.forEach((row) => {
    console.log(`User: ${row["name"]}`);
  });
});

// Delete the tenant
await client.deleteTenant("tenant_name");
```

## Documentation

Below is a list of the available functionality in the SDK. Using the SDK you can create a new tenants and point them to existing or new databases. You can also easily route data requests based on tenant names. For more detailed information, please refer to the [Fortress API documentation](https://docs.fortress.build).

Database Management:

- `create_database(database_name: str, alias: str)`: Creates a new database.
- `delete_database(database_name: str)`: Deletes to a database.
- `list_databases()`: Lists all databases.
- `connect_database(database_id: str)`: Connects to a database and turns into SQL connection.

Tenant Management:

- `create_tenant(tenant_name: str, alias: str, database_id: str = "")`: Creates a new tenant.
- `delete_tenant(tenant_name: str)`: Deletes a tenant.
- `list_tenants()`: Lists all tenants.
- `connect_tenant(tenant_name: str)`: Connects to a tenant and turns into SQL connection.

## Configuration

To use the SDK, generate an API key from the Fortress dashboard to initialize the client. Also, provide the organization ID, which is available under the API Keys page on the platform website.

## License

This SDK is licensed under the MIT License.

## Support

If you have any questions or need help, don't hesitate to get in touch with our support team at founders@fortress.build.

```

```