@link Directive

The @link directive connects external resources to your GQLForge configuration. Use it to import protobuf definitions, JavaScript handlers, TLS certificates, and more.

Fields

Field	Type	Required	Description
`id`	String	No	An identifier used to reference this linked resource elsewhere.
`src`	String	Yes	URL or local file path to the resource.
`type_of`	LinkType	Yes	The kind of resource being linked. See table below.
`headers`	[Header]	No	HTTP headers sent when fetching a remote `src`.
`meta`	JSON	No	Arbitrary metadata attached to the link.
`proto_paths`	[String]	No	Additional search paths for protobuf imports.

Link Types

Type	Description
`Config`	Another GQLForge configuration file to merge into the current schema.
`Protobuf`	A `.proto` file defining gRPC service interfaces.
`Script`	A JavaScript file providing custom resolver functions.
`Cert`	A TLS certificate file (PEM format).
`Key`	A TLS private key file (PEM format).
`Operation`	A file containing persisted GraphQL operations.
`Htpasswd`	An htpasswd file for basic authentication.
`Jwks`	A JWKS endpoint or file for JWT validation.
`Grpc`	A gRPC reflection endpoint for service discovery.
`Sql`	A SQL file containing `CREATE TABLE` statements for schema definition.
`Postgres`	A PostgreSQL connection URL (e.g. `postgres://user:pass@host/db`).
`S3`	An S3 or S3-compatible endpoint URL for the `@s3` directive.

Examples

Linking a JavaScript handler

schema @link(src: "./handlers.js", type_of: Script) @server(port: 8000) {
  query: Query
}

Linking a protobuf file

schema
@link(
  id: "news"
  src: "./news.proto"
  type_of: Protobuf
  proto_paths: ["./proto"]
)
@server(port: 8000) {
  query: Query
}

Linking a PostgreSQL database

schema
@link(type: Postgres, src: "postgres://user:password@localhost:5432/mydb")
@link(type: Sql, src: "./migrations/schema.sql")
@server(port: 8000) {
  query: Query
  mutation: Mutation
}

Linking multiple PostgreSQL databases

When connecting to multiple databases, each @link(type: Postgres) must have a unique id. Use the db field on @postgres to specify which connection to query.

schema
@link(id: "main", type: Postgres, src: "postgres://localhost:5432/main_db")
@link(id: "analytics", type: Postgres, src: "postgres://localhost:5432/analytics_db")
@server(port: 8000) {
  query: Query
}

Linking an S3 storage endpoint

schema
@link(id: "aws", type: S3, src: "https://s3.ap-northeast-1.amazonaws.com", meta: { region: "ap-northeast-1" })
@server(port: 8000) {
  query: Query
}

Linking a JWKS provider for authentication

schema @link(id: "jwks", src: "https://example.com/.well-known/jwks.json", type_of: Jwks) @server(port: 8000) {
  query: Query
}