Hasura

About

The SettleMint Hasura SDK provides a seamless way to interact with Hasura GraphQL APIs for managing application data. It enables you to easily query and mutate data stored in your SettleMint-powered PostgreSQL databases through a type-safe GraphQL interface.

API Reference

Functions

createHasuraClient()

createHasuraClient<Setup>(options, clientOptions?, logger?): object

Defined in: sdk/hasura/src/hasura.ts:81

Creates a Hasura GraphQL client with proper type safety using gql.tada

Type Parameters

Parameters

Returns

object

An object containing:

• client: The configured GraphQL client instance
• graphql: The initialized gql.tada function for type-safe queries

Throws

Will throw an error if the options fail validation against ClientOptionsSchema

Example

import { createHasuraClient } from '@settlemint/sdk-hasura';
import type { introspection } from "@schemas/hasura-env";
import { createLogger, requestLogger } from "@settlemint/sdk-utils/logging";
 
const logger = createLogger();
 
const { client, graphql } = createHasuraClient<{
  introspection: introspection;
  disableMasking: true;
  scalars: {
    timestamp: string;
    timestampz: string;
    uuid: string;
    date: string;
    time: string;
    jsonb: string;
    numeric: string;
    interval: string;
    geometry: string;
    geography: string;
  };
}>({
  instance: process.env.SETTLEMINT_HASURA_ENDPOINT,
  accessToken: process.env.SETTLEMINT_ACCESS_TOKEN,
  adminSecret: process.env.SETTLEMINT_HASURA_ADMIN_SECRET,
}, {
  fetch: requestLogger(logger, "hasura", fetch) as typeof fetch,
});
 
// Making GraphQL queries
const query = graphql(`
  query GetUsers {
    users {
      id
      name
      email
    }
  }
`);
 
const result = await client.request(query);

createPostgresPool()

createPostgresPool(databaseUrl): Pool

Defined in: sdk/hasura/src/postgres.ts:83

Creates a PostgreSQL connection pool with error handling and retry mechanisms

Parameters

Returns

Pool

A configured PostgreSQL connection pool

Throws

Will throw an error if called from browser runtime

Example

import { createPostgresPool } from '@settlemint/sdk-hasura';
 
const pool = createPostgresPool(process.env.SETTLEMINT_HASURA_DATABASE_URL);
 
// The pool will automatically handle connection errors and retries
const client = await pool.connect();
try {
  const result = await client.query('SELECT NOW()');
  console.log(result.rows[0]);
} finally {
  client.release();
}

Type Aliases

ClientOptions

ClientOptions = object

Defined in: sdk/hasura/src/hasura.ts:26

Type definition for client options derived from the ClientOptionsSchema.

Type declaration

RequestConfig

RequestConfig = ConstructorParameters<typeof GraphQLClient>[1]

Defined in: sdk/hasura/src/hasura.ts:11

Type definition for GraphQL client configuration options

Variables

ClientOptionsSchema

const ClientOptionsSchema: ZodObject<ClientOptions>

Defined in: sdk/hasura/src/hasura.ts:16

Schema for validating client options for the Hasura client.

Contributing

We welcome contributions from the community! Please check out our Contributing guide to learn how you can help improve the SettleMint SDK through bug reports, feature requests, documentation updates, or code contributions.

License

The SettleMint SDK is released under the FSL Software License. See the LICENSE file for more details.