Struct Mysql 

pub struct Mysql { /* private fields */ }

Capabilities

This service can be used to:

• create_dir
• stat
• read
• write
• delete
• copy
• rename
• list
• presign

Configuration

• root: Set the working directory of OpenDAL
• connection_string: Set the connection string of mysql server
• table: Set the table of mysql
• key_field: Set the key field of mysql
• value_field: Set the value field of mysql

Example

Via Builder

use anyhow::Result;
use opendal::services::Mysql;
use opendal::Operator;

#[tokio::main]
async fn main() -> Result<()> {
    let mut builder = Mysql::default()
        .root("/")
        .connection_string("mysql://you_username:your_password@127.0.0.1:5432/your_database")
        .table("your_table")
        // key field type in the table should be compatible with Rust's &str like text
        .key_field("key")
        // value field type in the table should be compatible with Rust's Vec<u8> like bytea
        .value_field("value");

    let op = Operator::new(builder)?.finish();
    Ok(())
}

Implementations

impl MysqlBuilder

pub fn connection_string(self, v: &str) -> Self

Available on crate feature services-mysql only.

Set the connection_string of the mysql service.

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

Url

This format 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.

pub fn root(self, root: &str) -> Self

Available on crate feature services-mysql only.

set the working directory, all operations will be performed under it.

default: “/”

pub fn table(self, table: &str) -> Self

Available on crate feature services-mysql only.

Set the table name of the mysql service to read/write.

pub fn key_field(self, key_field: &str) -> Self

Available on crate feature services-mysql only.

Set the key field name of the mysql service to read/write.

Default to key if not specified.

pub fn value_field(self, value_field: &str) -> Self

Available on crate feature services-mysql only.

Set the value field name of the mysql service to read/write.

Default to value if not specified.

Trait Implementations

impl Builder for MysqlBuilder

Available on crate feature services-mysql only.

type Config = MysqlConfig

Associated configuration for this builder.

fn build(self) -> Result<impl Access>

Consume the accessor builder to build a service.

impl Debug for MysqlBuilder

Available on crate feature services-mysql only.

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MysqlBuilder

Available on crate feature services-mysql only.

fn default() -> MysqlBuilder

Returns the “default value” for a type.