Struct Postgresql 

pub struct Postgresql { /* private fields */ }

PostgreSQL services support.

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 postgres server
• table: Set the table of postgresql
• key_field: Set the key field of postgresql
• value_field: Set the value field of postgresql

Example

Via Builder

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

#[tokio::main]
async fn main() -> Result<()> {
    let mut builder = Postgresql::default()
        .root("/")
        .connection_string("postgresql://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 PostgresqlBuilder

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

Available on crate feature services-postgresql only.

Set the connection url string of the postgresql service.

The URL should be with a scheme of either postgres:// or postgresql://.

• postgresql://user@localhost
• postgresql://user:password@%2Fvar%2Flib%2Fpostgresql/mydb?connect_timeout=10
• postgresql://user@host1:1234,host2,host3:5678?target_session_attrs=read-write
• postgresql:///mydb?user=user&host=/var/lib/postgresql

For more information, please visit https://docs.rs/sqlx/latest/sqlx/postgres/struct.PgConnectOptions.html.

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

Available on crate feature services-postgresql 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-postgresql only.

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

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

Available on crate feature services-postgresql only.

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

Default to key if not specified.

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

Available on crate feature services-postgresql only.

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

Default to value if not specified.

Trait Implementations

impl Builder for PostgresqlBuilder

Available on crate feature services-postgresql only.

type Config = PostgresqlConfig

Associated configuration for this builder.

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

Consume the accessor builder to build a service.

impl Debug for PostgresqlBuilder

Available on crate feature services-postgresql only.

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

Formats the value using the given formatter.

impl Default for PostgresqlBuilder

Available on crate feature services-postgresql only.

fn default() -> PostgresqlBuilder

Returns the “default value” for a type.