search

traindb-project / traindb-ml

Remote ML Model Serving Component for TrainDB
Apache License 2.0
6 stars 2 forks source link

spec: Parameters for Database Source Definition #15

Open sungsoo opened 2 years ago

sungsoo commented 2 years ago

spec: Parameters for Database Source Definition

Last Update: 11 July 2022

This page describes the parameter specification related to database access of TrainDB-ML, DB source.

If you have comments or suggestions, feel free to let us know. (Please leave your comment about this article below.)

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 RFC2119 RFC8174 when, and only when, they appear in all capitals, as shown here.

This document is licensed under The Apache License, Version 2.0.

Here is a concrete example on how to connect to a MySQL database. (reference: mindsdb)

CREATE DATABASE mysql_datasource
WITH
    engine='mysql',
    parameters={
            "user":"root",
            "port": 3306,
            "password": "Mimzo3i-mxt@9CpThpBj",
            "host": "127.0.0.1",
            "database": "instacart"
    };

In the TrainDB-ML perspective, we receive the parameters for database access from the TrainDB main as the following.

engine='mysql',
parameters={
        "user":"root",
        "port": 3306,
        "password": "Mimzo3i-mxt@9CpThpBj",
        "host": "127.0.0.1",
        "database": "instacart"
};

The parameter `engine' have the following values according to legacy DBMS.

Legacy DBMS access parameters

The following table presents the specification of parameters for legacy DBMS access.

Field Name Type Description
engine String This fields represents a name of legacy DBMS to access.
user String This fields represents a user ID of legacy DBMS.
password String This fields represents a plain (not encrypted) password for database access.
host String This fields represents a host uri (e.g. IP address) for database access.
port Integer This fields represent a port number for database access.
database String This fields represents a name of a database existed in legacy DBMS. In case of Kairos DBMS, a value of this fields equals to a value of user field.
ssl String TBD "enabled" or "disabled" This fields represents an access mode (SSL/TLS or not) for database connection.
ssl-ca File TBD This fields represents a certificates for DBMS access security. Secure Socket Layer (SSL) or Transport Layer Security (TLS) from the TrainDB-ML to encrypt a connection to a DB instance running MySQL, PostgreSQL, and so on.

References

  1. OpenAPI Specification
  2. CREATE DATABASE Statement