Class Database<T>`Abstract`

Represents a database connection.

Type Parameters

T extends DatabaseStructure
The structure of the database.

Implements

DatabaseBase

Index

Constructors

`Protected`constructor

new Database<T extends DatabaseStructure>(
host: HostBase,
conn: databaseOptionsWithExternalSources<unknown>,
): Database<T>
Type Parameters
- T extends DatabaseStructure
  The structure of the database.
Parameters
- host: HostBase
- conn: databaseOptionsWithExternalSources<unknown>
Returns Database<T>
- Defined in src/connection/database.ts:34

Properties

`Protected`canOpenNewConnections

canOpenNewConnections: boolean = true

`Readonly`debug

debug: boolean

`Readonly`host

host: HostBase

`Readonly`name

name: string

Accessors

endpoint

get endpoint(): | `https://${string}/fmi/data/v2/databases/${string}`
| `http://${string}/fmi/data/v2/databases/${string}`
Returns the endpoint URL for the database connection.

Returns
| `https://${string}/fmi/data/v2/databases/${string}`
| `http://${string}/fmi/data/v2/databases/${string}`
The endpoint URL.
Implementation of DatabaseBase.endpoint
- Defined in src/connection/database.ts:72

Methods

[asyncDispose]

"[asyncDispose]"(): Promise<void>
Returns Promise<void>
- Defined in src/connection/database.ts:56

clearLayoutCache

clearLayoutCache(): void
Clears any Layout objects previously returned by database.layout(...).

Returns void
- Defined in src/connection/database.ts:162

close

close(): Promise<void>
Immediately closes all open sessions and prevents new ones from being created.

Returns Promise<void>
Implementation of DatabaseBase.close
- Defined in src/connection/database.ts:51

fetch

fetch(url: string | URL, options?: RequestInit): Promise<Response>
Uses an available session to run a fetch
Parameters
- url: string | URL
- Optionaloptions: RequestInit
Returns Promise<Response>
Implementation of DatabaseBase.fetch
- Defined in src/connection/database.ts:81

fetchJSON

fetchJSON<
    T extends
        ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
        | null = null,
>(
    url: string | URL,
    options: RequestInit & { type: T },
): Promise<
    T extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
        ? output<T> & { httpStatus: number }
        : { httpStatus: number },
>
Uses an available session to run a fetch on a FileMaker Data API JSON endpoint. Also applies JSON/Zod type enforcement on result.
Type Parameters
- T extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> | null = null
Parameters
- url: string | URL
- options: RequestInit & { type: T }
Returns Promise<
    T extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
        ? output<T> & { httpStatus: number }
        : { httpStatus: number },
>
Implementation of DatabaseBase.fetchJSON
- Defined in src/connection/database.ts:88

layout

layout<R extends string | number | symbol>(name: R): Layout<T["layouts"][R]>
Type Parameters
- R extends string | number | symbol
Parameters
- name: R
Returns Layout<T["layouts"][R]>
- Defined in src/connection/database.ts:148
layout<R extends LayoutInterface>(name: string): Layout<R>
Type Parameters
- R extends LayoutInterface
Parameters
- name: string
Returns Layout<R>
- Defined in src/connection/database.ts:149

listLayouts

listLayouts(page?: number): Promise<Layout<LayoutInterface>[]>
Retrieves a list of layouts in the current FileMaker database.
Parameters
- page: number = 0
Returns Promise<Layout<LayoutInterface>[]>
A promise that resolves to an array of Layout objects.

Throws
If there was an error retrieving the layouts.
- Defined in src/connection/database.ts:132

login(): Promise<void>
Returns Promise<void>
Deprecated
login is deprecated and is now handled by newer session management. This function is simply a placeholder.
Implementation of DatabaseBase.login
- Defined in src/connection/database.ts:43

logout

logout(): Promise<void>
Immediately closes all open sessions and prevents new ones from being created. Alias of close

Returns Promise<void>
Implementation of DatabaseBase.logout
- Defined in src/connection/database.ts:47

script

script(name: string, parameter?: string): Script
Creates a script reference you can pass to read and write helpers.
Parameters
- name: string
- parameter: string = ''
Returns Script
- Defined in src/connection/database.ts:167

`Protected` `Abstract`withSession

withSession<T>(
    callback: (
        session: {
            fetch: (url: string | URL, init?: RequestInit) => Promise<Response>;
            validate: () => Promise<void>;
            logout(): Promise<void>;
        },
    ) => Promise<T>,
): Promise<T>
Protected
The inheriting database class must implement this method to provide a session object.
Type Parameters
- T
Parameters
- callback: (
      session: {
          fetch: (url: string | URL, init?: RequestInit) => Promise<Response>;
          validate: () => Promise<void>;
          logout(): Promise<void>;
      },
  ) => Promise<T>
Returns Promise<T>
- Defined in src/connection/database.ts:65

Class Database<T>Abstract

Type Parameters

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns Database<T>

Properties

ProtectedcanOpenNewConnections

Readonlydebug

Readonlyhost

Readonlyname

Accessors

endpoint

Returns | `https://${string}/fmi/data/v2/databases/${string}` | `http://${string}/fmi/data/v2/databases/${string}`

Methods

[asyncDispose]

Returns Promise<void>

clearLayoutCache

Returns void

close

Returns Promise<void>

fetch

Parameters

Returns Promise<Response>

fetchJSON

Type Parameters

Parameters

Returns Promise< T extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>> ? output<T> & { httpStatus: number } : { httpStatus: number },>

layout

Type Parameters

Parameters

Returns Layout<T["layouts"][R]>

Type Parameters

Parameters

Returns Layout<R>

listLayouts

Parameters

Returns Promise<Layout<LayoutInterface>[]>

Throws

login

Returns Promise<void>

Deprecated

logout

Returns Promise<void>

script

Parameters

Returns Script

Protected AbstractwithSession

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page

Class Database<T>`Abstract`

`Protected`constructor

`Protected`canOpenNewConnections

`Readonly`debug

`Readonly`host

`Readonly`name

Returns
| `https://${string}/fmi/data/v2/databases/${string}`
| `http://${string}/fmi/data/v2/databases/${string}`

Returns Promise<
T extends ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>
? output<T> & { httpStatus: number }
: { httpStatus: number },
>

`Protected` `Abstract`withSession