# Filament

## Docs

- [Connections](https://filament.getgalaxy.io/pages/api-reference/service/connections.md): Reusable, tenant-scoped sources and sinks.
- [API Reference](https://filament.getgalaxy.io/pages/api-reference/service/introduction.md): The IngestionService ConnectRPC API the pipeline UI drives.
- [Pipelines](https://filament.getgalaxy.io/pages/api-reference/service/pipelines.md): The persisted node graph connecting a source to a sink.
- [Providers](https://filament.getgalaxy.io/pages/api-reference/service/providers.md): The connector catalog — registered sources, sinks, and their config schemas.
- [Runs](https://filament.getgalaxy.io/pages/api-reference/service/runs.md): Compiling and submitting a pipeline, then tracking or signaling it.
- [Secrets](https://filament.getgalaxy.io/pages/api-reference/service/secrets.md): Write-only values referenced by name from connector configs.
- [Event Bus Publish Overhead](https://filament.getgalaxy.io/pages/benchmarks/event-bus/publish-overhead.md): Publish cost with no subscribers, fan-out, and contention.
- [Methodology](https://filament.getgalaxy.io/pages/benchmarks/methodology/introduction.md): How Filament is benchmarked: the subtraction ladder.
- [Pipeline Throughput](https://filament.getgalaxy.io/pages/benchmarks/pipeline/throughput.md): BenchmarkNullSinkPipeline and its parallel variant.
- [Optional Interfaces](https://filament.getgalaxy.io/pages/connectors/building-a-connector/optional-interfaces.md): The capabilities a source or sink can opt into beyond the base contract.
- [Writing a Sink](https://filament.getgalaxy.io/pages/connectors/building-a-connector/writing-a-sink.md): The Sink interface and how to implement it.
- [Writing a Source](https://filament.getgalaxy.io/pages/connectors/building-a-connector/writing-a-source.md): The Source interface and how to implement it.
- [Connectors Overview](https://filament.getgalaxy.io/pages/connectors/overview/introduction.md): How sources and sinks plug into Filament.
- [AWS S3](https://filament.getgalaxy.io/pages/connectors/sinks/aws-s3.md): Write NDJSON objects to Amazon S3 or any S3-compatible endpoint.
- [Iceberg](https://filament.getgalaxy.io/pages/connectors/sinks/iceberg.md): Write to Apache Iceberg tables.
- [MySQL](https://filament.getgalaxy.io/pages/connectors/sinks/mysql.md): Write to MySQL.
- [Sinks Overview](https://filament.getgalaxy.io/pages/connectors/sinks/overview.md): Connectors Filament can write to.
- [PostgreSQL](https://filament.getgalaxy.io/pages/connectors/sinks/postgres.md): Write to PostgreSQL.
- [Stdout](https://filament.getgalaxy.io/pages/connectors/sinks/stdout.md): Print records to stdout — for local development and debugging.
- [Attio](https://filament.getgalaxy.io/pages/connectors/sources/attio.md): Read CRM records, lists, and activity from Attio.
- [GitHub](https://filament.getgalaxy.io/pages/connectors/sources/github.md): Read repositories, issues, and pull requests from a GitHub organization.
- [HTTP](https://filament.getgalaxy.io/pages/connectors/sources/http.md): A manifest-driven source for REST APIs.
- [Linear](https://filament.getgalaxy.io/pages/connectors/sources/linear.md): Read teams, issues, and projects from Linear's GraphQL API.
- [MySQL](https://filament.getgalaxy.io/pages/connectors/sources/mysql.md): Keyset reads and GTID-based CDC from MySQL.
- [Notion](https://filament.getgalaxy.io/pages/connectors/sources/notion.md): Read databases, pages, and blocks from a Notion workspace.
- [Sources Overview](https://filament.getgalaxy.io/pages/connectors/sources/overview.md): Connectors Filament can read from.
- [PostgreSQL](https://filament.getgalaxy.io/pages/connectors/sources/postgres.md): Resumable full-snapshot and incremental reads from PostgreSQL.
- [Sample](https://filament.getgalaxy.io/pages/connectors/sources/sample.md): Synthetic data for testing pipelines without a real upstream.
- [Slack](https://filament.getgalaxy.io/pages/connectors/sources/slack.md): Read channels, messages, and files from a Slack workspace.
- [Architecture](https://filament.getgalaxy.io/pages/guides/concepts/architecture.md): The server, control plane, and worker, over a data store and an event bus.
- [Integrity & Checkpoints](https://filament.getgalaxy.io/pages/guides/concepts/integrity-and-checkpoints.md): How Filament verifies every batch and resumes interrupted runs.
- [Replication Modes](https://filament.getgalaxy.io/pages/guides/concepts/replication-modes.md): Full, incremental, and CDC — how a source reads.
- [Local Development](https://filament.getgalaxy.io/pages/guides/contributing/local-development.md): Set up the toolchain and run Filament from source.
- [Style & Testing](https://filament.getgalaxy.io/pages/guides/contributing/style-and-testing.md): Formatting, linting, and the two test tiers.
- [Configuration](https://filament.getgalaxy.io/pages/guides/deployment/configuration.md): Runtime configuration, locally and in Kubernetes.
- [Embedding as a Library](https://filament.getgalaxy.io/pages/guides/deployment/embedding-as-a-library.md): Run Filament inside your own Go process.
- [Kubernetes](https://filament.getgalaxy.io/pages/guides/deployment/kubernetes.md): Deploy Filament with the Helm chart.
- [Installation](https://filament.getgalaxy.io/pages/guides/get-started/installation.md): The two ways to run Filament: embed it as a Go library, or deploy it as a service.
- [Introduction](https://filament.getgalaxy.io/pages/guides/get-started/introduction.md): What Filament is and how its pieces fit together.
- [Quickstart](https://filament.getgalaxy.io/pages/guides/get-started/quickstart.md): Run Filament locally in three commands.