Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nodefluent/bigquery-kafka-connect
:cloud: nodejs kafka connect connector for Google BigQuery
https://github.com/nodefluent/bigquery-kafka-connect
big-data bigquery connect etl google-cloud kafka kafka-connect nodejs
Last synced: 3 months ago
JSON representation
:cloud: nodejs kafka connect connector for Google BigQuery
- Host: GitHub
- URL: https://github.com/nodefluent/bigquery-kafka-connect
- Owner: nodefluent
- License: mit
- Created: 2017-05-25T14:23:16.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-03T14:37:18.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T07:54:11.507Z (7 months ago)
- Topics: big-data, bigquery, connect, etl, google-cloud, kafka, kafka-connect, nodejs
- Language: JavaScript
- Homepage:
- Size: 1.75 MB
- Stars: 18
- Watchers: 8
- Forks: 3
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-kafka - BigQuery
README
# bigquery-kafka-connect
[](https://greenkeeper.io/)
Kafka Connect connector for Google BigQuery
[](https://travis-ci.org/nodefluent/bigquery-kafka-connect)
[](https://coveralls.io/github/nodefluent/bigquery-kafka-connect?branch=master)
## Use API
```
npm install --save bigquery-kafka-connect
```
### bigquery -> kafka
```es6
const { runSourceConnector } = require("bigquery-kafka-connect");
runSourceConnector(config, [], onError).then(config => {
//runs forever until: config.stop();
});
```
### kafka -> bigquery
```es6
const { runSinkConnector } = require("bigquery-kafka-connect");
runSinkConnector(config, [], onError).then(config => {
//runs forever until: config.stop();
});
```
### kafka -> bigquery (with custom topic (no source-task topic))
```es6
const { runSinkConnector, ConverterFactory } = require("bigquery-kafka-connect");
const bigQueryTableDescription = {
"schema": {
"fields": [
{ name: "id", type: "INTEGER", mode: "REQUIRED" },
{ name: "name", type: "STRING", mode: "REQUIRED" },
{ name: "info", type: "STRING", mode: "NULLABLE" }
]
},
"timePartitioning": {"type": "DAY"}
};
const etlFunc = (messageValue, callback) => {
//type is an example json format field
if (messageValue.type === "publish") {
return callback(null, {
id: messageValue.payload.id,
name: messageValue.payload.name,
info: messageValue.payload.info
});
}
if (messageValue.type === "unpublish") {
return callback(null, null); //null value will cause deletion
}
callback(new Error("unknown messageValue.type"));
};
const converter = ConverterFactory.createSinkSchemaConverter(bigQueryTableDescription, etlFunc);
runSinkConnector(config, [converter], onError).then(config => {
//runs forever until: config.stop();
});
/*
this example would be able to store kafka message values
that look like this (so completely unrelated to messages created by a default SourceTask)
{
payload: {
id: 1,
name: "first item",
info: "some info"
},
type: "publish"
}
*/
```
## Use CLI
note: in BETA :seedling:
```
npm install -g bigquery-kafka-connect
```
```
# run source etl: bigquery -> kafka
nkc-bigquery-source --help
```
```
# run sink etl: kafka -> bigquery
nkc-bigquery-sink --help
```
## Config(uration)
```es6
const config = {
kafka: {
kafkaHost: "localhost:9092",
logger: null,
groupId: "kc-bigquery-test",
clientName: "kc-bigquery-test-name",
workerPerPartition: 1,
options: {
sessionTimeout: 8000,
protocol: ["roundrobin"],
fromOffset: "earliest", //latest
fetchMaxBytes: 1024 * 100,
fetchMinBytes: 1,
fetchMaxWaitMs: 10,
heartbeatInterval: 250,
retryMinTimeout: 250,
requireAcks: 1,
//ackTimeoutMs: 100,
//partitionerType: 3
}
},
topic: "sc_test_topic",
partitions: 1,
maxTasks: 1,
pollInterval: 2000,
produceKeyed: true,
produceCompressionType: 0,
connector: {
batchSize: 500,
maxPollCount: 500,
projectId: "bq-project-id",
dataset: "bq_dataset",
table: "bq_table",
idColumn: "id"
},
http: {
port: 3149,
middlewares: []
},
enableMetrics: true,
batch: {
batchSize: 100,
commitEveryNBatch: 1,
concurrency: 1,
commitSync: true
}
};
```
## Native Client Config(uration)
```es6
const config = {
kafka: {
noptions: {
"metadata.broker.list": "localhost:9092",
"group.id": "kc-bigquery-test",
"enable.auto.commit": false,
"debug": "all",
"event_cb": true,
"client.id": "kc-bigquery-test-name"
},
tconf: {
"auto.offset.reset": "earliest",
"request.required.acks": 1
}
},
topic: "sc_test_topic",
partitions: 1,
maxTasks: 1,
pollInterval: 2000,
produceKeyed: true,
produceCompressionType: 0,
connector: {
batchSize: 500,
maxPollCount: 500,
projectId: "bq-project-id",
dataset: "bq_dataset",
table: "bq_table",
idColumn: "id"
},
http: {
port: 3149,
middlewares: []
},
enableMetrics: true
};
```