You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

  • Motivation:
    • current way of managing job config via files makes it hard to manage job configurations, persisting it in MySQL would make it easier to manage and also provide various CRUD API interfaces to mange the job configuration.
  • Proposed Change: 
    • create MySQL table `gobblin_job_config`
    • create REST endpoints for CRUD operations
    • add functionality to detect change in any job config and schedule or trigger job accordingly ( similar to current mechanism based on file change )
    • In future, Gobblin should use JDBI (v3) as ORM instead of plan JDBC based persistence which will become cumbersome as it uses DB heavily for all kinds of metadata storage.
  • New or Changed Public Interfaces:
    • POST /job/{jobName}
    • PUT /job//{jobName}
    • GET /job/{jobName}
    • DELETE /job/{jobName}
  • Migration Plan and Compatibility: 
    • since this is new functionality, in addition to the current file based job config, user can select either one to manage the job.
  • Rejected Alternatives:
    • use of other REST framework ( preferring to use REST.li instead of dropwizard or any other as its built in framework for other APIs

Design:


MySQL tables:

gobblin_job_config
CREATE TABLE `gobblin_job_owners` (
     `name` varchar(255) NOT NULL DEFAULT '',
     `email` varchar(255) NOT NULL DEFAULT '',
     `team_name` int(11) DEFAULT NULL,
     `team_email` int(11) DEFAULT NULL,
     `org_name` int(11) DEFAULT NULL,
     `created_date` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
     `updated_date` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
     PRIMARY KEY (`email`)
);

CREATE TABLE `gobblin_sync_systems` (
    `name` varchar(255) NOT NULL DEFAULT '',
    `db_type` varchar(255) NOT NULL DEFAULT '',
    `users` varchar(255) NOT NULL DEFAULT '',
    `on_hold` tinyint(1) NOT NULL DEFAULT '0',
    `deprecated` tinyint(1) NOT NULL DEFAULT '0',
    `config` text,
    `created_date` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
    `updated_date` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`name`)
);

CREATE TABLE `gobblin_jobs` (
    `id` int(11) NOT NULL AUTO_INCREMENT,
    `name` varchar(255) NOT NULL,
    `description` varchar(255) DEFAULT NULL,
    `schedule` varchar(64) DEFAULT NULL,
    `is_disabled` tinyint(1) DEFAULT '0',
    `priority` smallint(6) DEFAULT NULL,
    `configs` text,
    `owner_email` int(11) DEFAULT NULL,
    `source_system` varchar(11) DEFAULT NULL,
    `target_system` varchar(11) DEFAULT NULL,
    `created_date` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
    `updated_date` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
    PRIMARY KEY (`name`),
    FOREIGN KEY (owner_email) REFERENCES gobblin_job_owners(email),
    FOREIGN KEY (source_system) REFERENCES gobblin_sync_systems(name),
    FOREIGN KEY (target_system) REFERENCES gobblin_sync_systems(name),
    INDEX (name),
    INDEX (id)
) AUTO_INCREMENT=1;

CREATE TABLE `gobblin_sync_systems_maintenance` (
    `id` int(11) NOT NULL AUTO_INCREMENT,
    `sync_system_name` varchar(255) NOT NULL DEFAULT '',
    `type` varchar(255) NOT NULL DEFAULT '',
    `start_time` datetime NOT NULL,
    `end_time` datetime NOT NULL,
    PRIMARY KEY (`id`),
    FOREIGN KEY (sync_system_name) REFERENCES gobblin_sync_systems(name)
);


  1. Create New job example
POST body
POST http://localhost:9090/job/PullFromWikipedia

{
	"jobName": "PullFromWikipedia",
	"jobDescription": "A getting started example for Gobblin",
	"jobDisabled": false,
	"jobProperties": {
		"job.group": "Wikipedia",
		"source.class": "org.apache.gobblin.example.wikipedia.WikipediaSource",
		"test_remove": "test_remove_value",
		"something": "asdsad"
	}
}


2. update existing job

POST body
POST http://localhost:9090/job/PullFromWikipedia

{
	"jobName": "PullFromWikipedia",
	"jobDescription": "A getting started example for Gobblin",
	"jobDisabled": false,
	"jobProperties": {
		"job.group": "Wikipedia",
		"source.class": "org.apache.gobblin.example.wikipedia.WikipediaSource",
		"test_remove": "test_remove_value",
		"something": "asdsad"
	},
	"_jobPropertiesToRemove": [ 
		"key" 
	]
}



3. GET existing job

GET Result
GET http://localhost:9090/job/PullFromWikipedia
{
    "jobName": "PullFromWikipedia",
    "jobId": 14,
    "jobProperties": {
        "source.class": "org.apache.gobblin.example.wikipedia.WikipediaSource",
        "test_remove": "test_remove_value",
        "job.group": "Wikipedia",
        "something": "asdsad"
    },
    "jobDisabled": false,
    "jobDescription": "A getting started example for Gobblin - pull some pages from wikipedia",
    "created_date": 1575937161000,
    "updated_date": 1575937161000
}




  • No labels