{"id":19530778,"url":"https://github.com/nodefluent/salesforce-kafka-connect","last_synced_at":"2025-04-26T13:30:52.583Z","repository":{"id":22301169,"uuid":"95870246","full_name":"nodefluent/salesforce-kafka-connect","owner":"nodefluent","description":"Salesforce connector for node kafka connect","archived":false,"fork":false,"pushed_at":"2022-12-03T15:48:29.000Z","size":1163,"stargazers_count":14,"open_issues_count":13,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-14T07:54:12.064Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nodefluent.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-06-30T09:02:53.000Z","updated_at":"2024-03-04T20:40:00.000Z","dependencies_parsed_at":"2023-01-12T08:30:35.286Z","dependency_job_id":null,"html_url":"https://github.com/nodefluent/salesforce-kafka-connect","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodefluent%2Fsalesforce-kafka-connect","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodefluent%2Fsalesforce-kafka-connect/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodefluent%2Fsalesforce-kafka-connect/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nodefluent%2Fsalesforce-kafka-connect/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nodefluent","download_url":"https://codeload.github.com/nodefluent/salesforce-kafka-connect/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224036168,"owners_count":17245029,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T01:36:15.166Z","updated_at":"2024-11-11T01:36:16.593Z","avatar_url":"https://github.com/nodefluent.png","language":"JavaScript","funding_links":[],"categories":["CRM \u0026 Marketing"],"sub_categories":["Salesforce"],"readme":"# salesforce-kafka-connect\n\n[![Greenkeeper badge](https://badges.greenkeeper.io/nodefluent/salesforce-kafka-connect.svg)](https://greenkeeper.io/)\nKafka Connect connector for Salesforce with bulk options configuration support.\n\n[![Build Status](https://travis-ci.org/nodefluent/salesforce-kafka-connect.svg?branch=master)](https://travis-ci.org/nodefluent/salesforce-kafka-connect)\n\n## Use API\n\n```\nnpm install --save salesforce-kafka-connect\n```\n\n### salesforce -\u003e kafka\n\n```es6\nconst { runSourceConnector } = require(\"salesforce-kafka-connect\");\nrunSourceConnector(config, [], onError).then(config =\u003e {\n    //runs forever until: config.stop();\n});\n```\n\n### kafka -\u003e salesforce\n\n```es6\nconst { runSinkConnector } = require(\"salesforce-kafka-connect\");\nrunSinkConnector(config, [], onError).then(config =\u003e {\n    //runs forever until: config.stop();\n});\n```\n\n### kafka -\u003e salesforce (with custom topic (no source-task topic))\n\n```es6\nconst { runSinkConnector, ConverterFactory } = require(\"salesforce-kafka-connect\");\n\nconst etlFunc = (messageValue, callback) =\u003e {\n\n    //type is an example json format field\n    if (messageValue.type === \"publish\") {\n        return callback(null, {\n            id: messageValue.payload.id,\n            name__c: messageValue.payload.name,\n            info__c: messageValue.payload.info\n        });\n    }\n\n    if (messageValue.type === \"unpublish\") {\n        return callback(null, null); //null value will cause deletion\n    }\n\n    callback(new Error(\"unknown messageValue.type\"));\n};\n\nconst converter = ConverterFactory.createSinkSchemaConverter({}, etlFunc);\n\nrunSinkConnector(config, [converter], onError).then(config =\u003e {\n    //runs forever until: config.stop();\n});\n\n/*\n    this example would be able to store kafka message values\n    that look like this (so completely unrelated to messages created by a default SourceTask)\n    {\n        payload: {\n            id: 1,\n            name__c: \"first item\",\n            info__c: \"some info\"\n        },\n        type: \"publish\"\n    }\n*/\n```\n\n## Use CLI\nnote: in BETA :seedling:\n\n```\nnpm install -g salesforce-kafka-connect\n```\n\n```\n# run source etl: salesforce -\u003e kafka\nnkc-salesforce-source --help\n```\n\n```\n# run sink etl: kafka -\u003e salesforce\nnkc-salesforce-sink --help\n```\n\n## Config(uration)\n```es6\nconst config = {\n    kafka: {\n        zkConStr: \"localhost:2181/\",\n        logger: null,\n        groupId: \"kc-salesforce-test\",\n        clientName: \"kc-salesforce-test-name\",\n        workerPerPartition: 1,\n        options: {\n            sessionTimeout: 8000,\n            protocol: [\"roundrobin\"],\n            fromOffset: \"earliest\", //latest\n            fetchMaxBytes: 1024 * 100,\n            fetchMinBytes: 1,\n            fetchMaxWaitMs: 10,\n            heartbeatInterval: 250,\n            retryMinTimeout: 250,\n            requireAcks: 1,\n            //ackTimeoutMs: 100,\n            //partitionerType: 3\n        }\n    },\n    topic: \"sc-test-topic\",\n    partitions: 1,\n    maxTasks: 1,\n    pollInterval: 2000,\n    produceKeyed: true,\n    produceCompressionType: 0,\n    connector: {\n        tokenAuth: {\n            oauth2: {\n                clientId: \"client-id\",\n                clientSecret: \"client-secret\",\n                redirectUri: \"redirect-uri\"\n            },\n            accessToken: \"access-token\",\n            refreshToken: \"refresh-token\"\n        }\n        // username: \"salesforce\",\n        // password: \"salesforce\",\n        loginUrl: \"https://test.salesforce.com\",\n        streamingSource: {\n            batchSize: 5,\n            topic: \"StreamingTopic\",\n            kafkaTopic: \"sf-test-topic\",\n            idProperty: \"id\"\n        },\n        restSink: {\n            sObject: \"sobject\",\n            idProperty: \"id\",\n            bulkOptions: {\n                concurrencyMode: 'Serial',\n            },\n            batchSize: 500\n        }\n    },\n    http: {\n        port: 3149,\n        middlewares: []\n    },\n    enableMetrics: true,\n    batch: {\n        batchSize: 100, \n        commitEveryNBatch: 1, \n        concurrency: 1,\n        commitSync: true\n    }\n};\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodefluent%2Fsalesforce-kafka-connect","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnodefluent%2Fsalesforce-kafka-connect","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnodefluent%2Fsalesforce-kafka-connect/lists"}