README
¶
hatchet-embedded
Run a full Hatchet engine (migrations, API, and gRPC) from your application — in-process from Go, or as a sidecar process from the TypeScript and Python SDKs. By default it also starts a bundled Postgres, so you need zero external services to get running.
Full documentation: docs.hatchet.run/v1/embedded
Quickstart
Go (in-process, via a blank import):
import (
hatchet "github.com/hatchet-dev/hatchet/sdks/go"
_ "github.com/hatchet-dev/hatchet-embedded"
)
client, err := hatchet.NewClient(hatchet.WithEmbedded())
TypeScript (a separate entry point, so it never ends up in production bundles):
import { HatchetEmbeddedClient } from '@hatchet-dev/typescript-sdk/v1/embedded';
const hatchet = await HatchetEmbeddedClient.init();
Python:
from hatchet_sdk import Hatchet
hatchet = Hatchet.from_embedded()
Runnable examples for all three live in examples.
Releases
Release tags correspond to the publicly released Hatchet engine version baked
into the sidecar: vX.Y.Z, or vX.Y.Z-N for sidecar-only fixes on the same
engine. Each release ships hatchet-embedded-sidecar binaries for
darwin/linux (signed and notarized on macOS), which the TypeScript and Python
SDKs download on first use.
License
MIT — see LICENSE.
Documentation
¶
Index ¶
- Constants
- type Config
- type Instance
- type Option
- func WithAPIPort(port int) Option
- func WithAdminUser(email, password string) Option
- func WithGRPCPort(port int) Option
- func WithKeysets(master, privateJWT, publicJWT []byte) Option
- func WithLogLevel(level string) Option
- func WithLogger(l *zerolog.Logger) Option
- func WithPostgres(url string) Option
- func WithPostgresDataDir(dir string) Option
- func WithRabbitMQ(url string) Option
- func WithoutAPI() Option
- func WithoutMigrations() Option
Constants ¶
const DefaultAPIPort = 28243
DefaultAPIPort is the port the embedded API binds to when it is free, so tooling like 'hatchet embedded-ui' can find an instance without configuration. Additional instances fall back to a random free port. The value avoids IANA-assigned services and the OS ephemeral range.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Instance ¶
type Instance struct {
// contains filtered or unexported fields
}
func StartServer ¶
func (*Instance) GRPCAddress ¶
type Option ¶
type Option func(*Config)
func WithAPIPort ¶
func WithAdminUser ¶
func WithGRPCPort ¶
func WithKeysets ¶
func WithLogLevel ¶
func WithLogger ¶
WithLogger routes embed's logging (and the bundled Postgres output) through a caller-supplied logger instead of the default one derived from the log level.
func WithPostgres ¶
func WithPostgresDataDir ¶
WithPostgresDataDir stores the bundled Postgres runtime and data under dir instead of the default per-project directory derived from the working directory. Two instances must not share a data dir concurrently.
func WithRabbitMQ ¶
func WithoutAPI ¶
func WithoutAPI() Option
func WithoutMigrations ¶
func WithoutMigrations() Option
Source Files
Directories