proton

Commentary

added in 0.1.15

Experimental support for the Proton streaming engine. Data is written through its JDBC driver. Streams must already exist before producing data into them.

---

Examples

Configuring the connection

{
    "connections": {
        "proton-env": {
            "kind": "proton",
            "connectionConfigs": {
                "host": "localhost",
                "port": 8123,
                "username": "proton-user",
                "password": "proton-pw",
                "db": "mydb"
            }
        }
    }
}

---

Specification

Connection JSON schema

{
    "type": "object",
    "properties": {
        "kind": {
            "type": "string",
            "const": "proton"
        },
        "connectionConfigs": {
            "type": "object",
            "properties": {
                "host": {
                    "type": "string"
                },
                "port": {
                    "type": "integer"
                },
                "db": {
                    "type": "string"
                },
                "username": {
                    "type": "string"
                },
                "password": {
                    "type": "string"
                }
            },
            "required": [
                "host",
                "port",
                "db"
            ]
        },
        "batchConfigs": {
            "type": "object",
            "properties": {
                "lingerMs": {
                    "type": "integer",
                    "minimum": 0
                },
                "batchRows": {
                    "type": "integer",
                    "minimum": 1
                }
            }
        }
    },
    "required": [
        "connectionConfigs"
    ]
}

Generator JSON schema

{
    "type": "object",
    "properties": {
        "connection": {
            "type": "string"
        },
        "name": {
            "type": "string"
        },
        "stream": {
            "type": "string"
        },
        "row": {
            "type": "object"
        },
        "localConfigs": {
            "type": "object",
            "properties": {
                "throttleMs": {
                    "oneOf": [
                        {
                            "type": "number",
                            "minimum": 0
                        },
                        {
                            "type": "object",
                            "properties": {
                                "_gen": {
                                    "type": "string"
                                }
                            },
                            "required": [
                                "_gen"
                            ]
                        }
                    ]
                },
                "maxEvents": {
                    "oneOf": [
                        {
                            "type": "integer",
                            "minimum": 0
                        },
                        {
                            "type": "object",
                            "properties": {
                                "_gen": {
                                    "type": "string"
                                }
                            },
                            "required": [
                                "_gen"
                            ]
                        }
                    ]
                },
                "kafkaKeyProtobufHint": {
                    "type": "object",
                    "properties": {
                        "schemaFile": {
                            "type": "string"
                        },
                        "message": {
                            "type": "string"
                        }
                    },
                    "required": [
                        "schemaFile",
                        "message"
                    ]
                },
                "jsonSchemaHint": {
                    "type": "object"
                },
                "maxBytes": {
                    "type": "integer",
                    "minimum": 1
                },
                "discard": {
                    "type": "object",
                    "properties": {
                        "rate": {
                            "type": "number",
                            "minimum": 0,
                            "maximum": 1
                        }
                    },
                    "required": [
                        "rate"
                    ]
                },
                "repeat": {
                    "type": "object",
                    "properties": {
                        "rate": {
                            "type": "number",
                            "minimum": 0,
                            "maximum": 1
                        },
                        "times": {
                            "oneOf": [
                                {
                                    "type": "integer",
                                    "minimum": 0
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "_gen": {
                                            "type": "string"
                                        }
                                    },
                                    "required": [
                                        "_gen"
                                    ]
                                }
                            ]
                        }
                    },
                    "required": [
                        "rate",
                        "times"
                    ]
                },
                "protobufSchemaHint": {
                    "type": "object",
                    "patternProperties": {
                        "^.*$": {
                            "type": "object",
                            "properties": {
                                "schemaFile": {
                                    "type": "string"
                                },
                                "message": {
                                    "type": "string"
                                }
                            },
                            "required": [
                                "schemaFile",
                                "message"
                            ]
                        }
                    }
                },
                "maxHistoryEvents": {
                    "type": "integer",
                    "minimum": 0
                },
                "maxMs": {
                    "type": "integer",
                    "minimum": 0
                },
                "time": {
                    "type": "integer"
                },
                "events": {
                    "type": "object",
                    "properties": {
                        "exactly": {
                            "oneOf": [
                                {
                                    "type": "integer",
                                    "minimum": 0
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "_gen": {
                                            "type": "string"
                                        }
                                    },
                                    "required": [
                                        "_gen"
                                    ]
                                }
                            ]
                        }
                    }
                },
                "delay": {
                    "type": "object",
                    "properties": {
                        "rate": {
                            "type": "number",
                            "minimum": 0,
                            "maximum": 1
                        },
                        "ms": {
                            "oneOf": [
                                {
                                    "type": "integer",
                                    "minimum": 0
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "_gen": {
                                            "type": "string"
                                        }
                                    },
                                    "required": [
                                        "_gen"
                                    ]
                                }
                            ]
                        }
                    },
                    "required": [
                        "rate",
                        "ms"
                    ]
                },
                "history": {
                    "type": "object",
                    "properties": {
                        "events": {
                            "type": "object",
                            "properties": {
                                "max": {
                                    "type": "integer",
                                    "minimum": 0
                                }
                            }
                        }
                    }
                },
                "avroSchemaHint": {
                    "type": "object"
                },
                "throttle": {
                    "type": "object",
                    "properties": {
                        "ms": {
                            "oneOf": [
                                {
                                    "type": "number",
                                    "minimum": 0
                                },
                                {
                                    "type": "object",
                                    "properties": {
                                        "_gen": {
                                            "type": "string"
                                        }
                                    },
                                    "required": [
                                        "_gen"
                                    ]
                                }
                            ]
                        }
                    }
                },
                "throughput": {
                    "oneOf": [
                        {
                            "type": "integer",
                            "minimum": 1
                        },
                        {
                            "type": "object",
                            "properties": {
                                "_gen": {
                                    "type": "string"
                                }
                            },
                            "required": [
                                "_gen"
                            ]
                        }
                    ]
                },
                "timeMultiplier": {
                    "oneOf": [
                        {
                            "type": "number"
                        },
                        {
                            "type": "object",
                            "properties": {
                                "_gen": {
                                    "type": "string"
                                }
                            },
                            "required": [
                                "_gen"
                            ]
                        }
                    ]
                },
                "kafkaValueProtobufHint": {
                    "type": "object",
                    "properties": {
                        "schemaFile": {
                            "type": "string"
                        },
                        "message": {
                            "type": "string"
                        }
                    },
                    "required": [
                        "schemaFile",
                        "message"
                    ]
                }
            }
        }
    },
    "required": [
        "stream",
        "row"
    ]
}