Function connect

Source
pub fn connect(address: impl IntoEndpoint) -> Connect<Any, Surreal<Any>>
Expand description

Connects to a local, remote or embedded database

ยงExamples

use surrealdb::engine::any::connect;

// Connect to a local endpoint
let db = connect("ws://localhost:8000").await?;

// Connect to a remote endpoint
let db = connect("wss://cloud.surrealdb.com").await?;

// Connect using HTTP
let db = connect("http://localhost:8000").await?;

// Connect using HTTPS
let db = connect("https://cloud.surrealdb.com").await?;

// Instantiate an in-memory instance
let db = connect("mem://").await?;

// Instantiate a file-backed instance (currently uses RocksDB)
let db = connect("file://path/to/database-folder").await?;

// Instantiate a RocksDB-backed instance
let db = connect("rocksdb://path/to/database-folder").await?;

// Instantiate a SurrealKV-backed instance
let db = connect("surrealkv://path/to/database-folder").await?;

// Instantiate an IndxDB-backed instance
let db = connect("indxdb://DatabaseName").await?;

// Instantiate a TiKV-backed instance
let db = connect("tikv://localhost:2379").await?;

// Instantiate a FoundationDB-backed instance
let db = connect("fdb://path/to/fdb.cluster").await?;