---
id: "canal"
type: "component"
kind: "change-data-capture"
provider: "default"
category: "messaging"
docs: "https://github.com/alibaba/canal/wiki"
url: "https://localhost:3000/catalogue/components/canal"
---

# Alibaba Canal

MySQL binlog CDC server that poses as a replica and publishes row changes.

| | |
|---|---|
| Provider | [default](https://localhost:3000/catalogue?provider=default) |
| Kind | [Change data capture](https://localhost:3000/catalogue/kinds/change-data-capture) |
| Category | Messaging |
| Official docs | [https://github.com/alibaba/canal/wiki](https://github.com/alibaba/canal/wiki) |

## Properties

| property | type | values | required | kind default | this component |
|---|---|---|---|---|---|
| `deployment` | enum | `deployer`, `adapter`, `admin` | no | "deployer" | inherited |
| `haCoordination` | enum | `none`, `zookeeper` | no | "none" | inherited |
| `managed` | boolean | — | no | false | **false** |
| `mode` | enum | `log-based`, `trigger`, `polling` | no | "log-based" | **"log-based"** |
| `ordered` | boolean | — | no | true | **true** |
| `schemaEvolution` | boolean | — | no | false | inherited |

Bold values are the ones this component pins.

## Rules that apply · 0

No rule selects this kind or its category.

## Other products of the same kind · 14

- [Data Transmission Service](https://localhost:3000/catalogue/components/alibaba-dts.md) `alibaba-dts` — alibabacloud
- [AWS DMS](https://localhost:3000/catalogue/components/aws-dms.md) `aws-dms` — aws
- [Amazon DynamoDB Streams](https://localhost:3000/catalogue/components/aws-dynamodb-streams.md) `aws-dynamodb-streams` — aws
- [Brooklin](https://localhost:3000/catalogue/components/brooklin.md) `brooklin` — default
- [Generic change data capture](https://localhost:3000/catalogue/components/change-data-capture.md) `change-data-capture` — default
- [Debezium](https://localhost:3000/catalogue/components/debezium.md) `debezium` — default
- [Estuary Flow](https://localhost:3000/catalogue/components/estuary.md) `estuary` — default
- [Apache Kafka Connect](https://localhost:3000/catalogue/components/kafka-connect.md) `kafka-connect` — default
- [Maxwell](https://localhost:3000/catalogue/components/maxwell.md) `maxwell` — default
- [Striim](https://localhost:3000/catalogue/components/striim.md) `striim` — default
- [Database Migration Service](https://localhost:3000/catalogue/components/google-database-migration-service.md) `google-database-migration-service` — gcp
- [Datastream](https://localhost:3000/catalogue/components/google-datastream.md) `google-datastream` — gcp
- [IBM Data Replication](https://localhost:3000/catalogue/components/ibm-data-replication.md) `ibm-data-replication` — ibm
- [OCI GoldenGate](https://localhost:3000/catalogue/components/oci-goldengate.md) `oci-goldengate` — oci

## Use it in a design

```yaml
nodes:
  - { id: "canal", component: "canal" }
```

## Source (`component` YAML, verbatim)

```yaml
# yaml-language-server: $schema=../../schema/component.schema.json
# Alibaba Canal: MySQL CDC that disguises itself as a MySQL slave, sends the dump protocol to the
# master and parses binlog events, so capture is log-based and in binlog order ("Canal wiki, Home").
# Self-hosted: canal-deployer server plus optional canal-adapter and canal-admin.
schemaVersion: "1"
type: "component"
id: "canal"
kind: "change-data-capture"
provider: "default"
docs: "https://github.com/alibaba/canal/wiki"
defaults:
  managed: false
  mode: "log-based"
  ordered: true
properties:
  deployment:
    type: "enum"
    values: ["deployer", "adapter", "admin"]
    default: "deployer"
  haCoordination:
    type: "enum"
    values: ["none", "zookeeper"]
    default: "none"
```

Human page: https://localhost:3000/catalogue/components/canal