Archived: Simple SQL querying using template literals with optional Zod schema validation.
npm install @destacks/sql@destacks/sqlSimple SQL querying using template literals with optional Zod schema validation.
@destacks/sql executes SQL queries using template literals with an optional Zod schema validation feature. It builds upon @libsql/client and sql-template-tag to offer templated database interactions, with optional TypeScript static typing, and runtime data validation.
- SQL Query Execution: Execute SQL queries against libSQL (SQLite-like) databases.
- Configuration Flexibility: Supports local, remote, and hybrid database configurations.
- Zod Schema Validation: Optional integration for TypeScript static typing and runtime data validation.
- Support for Multiple Environments: Compatible with Node.js, browsers, and cloud or edge hosted environments.
``bash`
npm i @destacks/sql
#### Creating a Database Client
`javascript
import { createClient } from "@destacks/sql";
// For a local SQLite database
const localClient = createClient({ url: "file:local.db" });
// For a remote libSQL database
const remoteClient = createClient({
url: "libsql://[your-sqld-host]",
authToken: "[your-token]",
});
`
#### Defining a Zod Schema
`typescript
import { z } from "zod";
const UserSchema = z.object({ id: z.string(), name: z.string() });
`
#### Executing SQL Queries
With schema validation:
`typescript
import { sql } from "your-utility-path";
sql(UserSchema)SELECT * FROM users WHERE id = ${userId};`
Without schema validation:
`javascriptSELECT * FROM users WHERE id = ${userId}
sql;`
- Local SQLite Files: Use file: URLs for local SQLite databases. Supported on Node.js environments.libsql:
- libSQL sqld Instances: Connect using URLs, with support for HTTP or WebSocket protocols. Suitable for both local and remote databases.authToken
- Remote Databases: Access databases hosted on services like Turso. Requires for secured access.
@destacks/sql/react provides a specialized module for React projects, integrating with server-cli-only for execution in React Server Components and Node.js CLI environments.
`javascript`
import { createClient, createSql } from "@destacks/sql/react";
For more information on how server-cli-only works and its integration, refer to the server-cli-only npm package.
To integrate @destacks/sql into your Next.js project, you need to update your Next.js configuration. This involves adding @destacks/sql to the serverComponentsExternalPackages array under the experimental key in your next.config.js file. Here's how you can do it:
`javascript
// next.config.js
const nextConfig = {
experimental: {
serverComponentsExternalPackages: ["@destacks/sql"],
},
};
module.exports = nextConfig;
`
This configuration ensures that @destacks/sql is recognized and properly handled by the Next.js framework, particularly when dealing with server components.
For detailed usage and configuration options, refer to the npm package of @destacks/sql`.
MIT License.