Package org.apache.opendal

Class ServiceConfig.Mysql

java.lang.Object

org.apache.opendal.ServiceConfig.Mysql

All Implemented Interfaces:

ServiceConfig

Enclosing interface:

ServiceConfig

public static class ServiceConfig.Mysql
extends Object
implements ServiceConfig

Configuration for service mysql.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.opendal.ServiceConfig

ServiceConfig.AliyunDrive, ServiceConfig.Alluxio, ServiceConfig.Atomicserver, ServiceConfig.Azblob, ServiceConfig.Azdls, ServiceConfig.Azfile, ServiceConfig.B2, ServiceConfig.Cacache, ServiceConfig.Chainsafe, ServiceConfig.CloudflareKv, ServiceConfig.Compfs, ServiceConfig.Cos, ServiceConfig.D1, ServiceConfig.Dashmap, ServiceConfig.Dbfs, ServiceConfig.Dropbox, ServiceConfig.Etcd, ServiceConfig.Fs, ServiceConfig.Gcs, ServiceConfig.Gdrive, ServiceConfig.Ghac, ServiceConfig.Github, ServiceConfig.Gridfs, ServiceConfig.HdfsNative, ServiceConfig.Http, ServiceConfig.Huggingface, ServiceConfig.Icloud, ServiceConfig.Ipfs, ServiceConfig.Ipmfs, ServiceConfig.Koofr, ServiceConfig.Lakefs, ServiceConfig.Libsql, ServiceConfig.Memcached, ServiceConfig.Memory, ServiceConfig.MiniMoka, ServiceConfig.Moka, ServiceConfig.Mongodb, ServiceConfig.Monoiofs, ServiceConfig.Mysql, ServiceConfig.NebulaGraph, ServiceConfig.Obs, ServiceConfig.Onedrive, ServiceConfig.Oss, ServiceConfig.Pcloud, ServiceConfig.Persy, ServiceConfig.Postgresql, ServiceConfig.Redb, ServiceConfig.Redis, ServiceConfig.S3, ServiceConfig.Seafile, ServiceConfig.Sftp, ServiceConfig.Sled, ServiceConfig.Sqlite, ServiceConfig.Supabase, ServiceConfig.Surrealdb, ServiceConfig.Swift, ServiceConfig.Upyun, ServiceConfig.VercelArtifacts, ServiceConfig.VercelBlob, ServiceConfig.Webdav, ServiceConfig.Webhdfs, ServiceConfig.YandexDisk

Field Summary

Fields

Modifier and Type	Field	Description
final String	connectionString	This connection string is used to connect to the mysql service.
final String	keyField	The key field name for mysql.
final String	root	The root for mysql.
final String	table	The table name for mysql.
final String	valueField	The value field name for mysql.

Constructor Summary

Constructors

Constructor	Description
Mysql()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	configMap()	Convert the structured config to a type erased config map.
String	scheme()	The scheme of the service.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

connectionString

public final String connectionString

This connection string is used to connect to the mysql service. There are url based formats.

The format of connect string resembles the url format of the mysql client. The format is: [scheme://][user[:[password]]@]host[:port][/schema][?attribute1=value1&attribute2=value2...

• mysql://user@localhost
• mysql://user:password@localhost
• mysql://user:password@localhost:3306
• mysql://user:password@localhost:3306/db

For more information, please refer to https://docs.rs/sqlx/latest/sqlx/mysql/struct.MySqlConnectOptions.html.

table

public final String table

The table name for mysql.

keyField

public final String keyField

The key field name for mysql.

valueField

public final String valueField

The value field name for mysql.

root

public final String root

The root for mysql.

Constructor Details

Mysql

public Mysql()

Method Details

scheme

public String scheme()

Description copied from interface: ServiceConfig

The scheme of the service.

Specified by:

scheme in interface ServiceConfig

Returns:

the scheme

configMap

public Map<String,String> configMap()

Description copied from interface: ServiceConfig

Convert the structured config to a type erased config map.

Specified by:

configMap in interface ServiceConfig

Returns:

the config map