pub struct CloudConfig {
pub endpoint: String,
pub username: String,
pub password: String,
pub namespace: String,
pub database: String,
pub is_root: bool,
}Expand description
Configuration for SurrealDB Cloud connection
Fields§
§endpoint: StringWebSocket endpoint URL (e.g., “wss://xxx.aws-use1.surrealdb.cloud”)
username: StringDatabase username
password: StringDatabase password
namespace: StringNamespace (default: “aivcs”)
database: StringDatabase name (default: “main”)
is_root: boolWhether this is a root user (true) or database user (false)
Implementations§
Source§impl CloudConfig
impl CloudConfig
Sourcepub fn new(
endpoint: impl Into<String>,
username: impl Into<String>,
password: impl Into<String>,
) -> Self
pub fn new( endpoint: impl Into<String>, username: impl Into<String>, password: impl Into<String>, ) -> Self
Create a new cloud configuration for a database user
Sourcepub fn new_root(
endpoint: impl Into<String>,
username: impl Into<String>,
password: impl Into<String>,
) -> Self
pub fn new_root( endpoint: impl Into<String>, username: impl Into<String>, password: impl Into<String>, ) -> Self
Create a new cloud configuration for a root user
Sourcepub fn with_namespace(self, ns: impl Into<String>) -> Self
pub fn with_namespace(self, ns: impl Into<String>) -> Self
Set custom namespace
Sourcepub fn with_database(self, db: impl Into<String>) -> Self
pub fn with_database(self, db: impl Into<String>) -> Self
Set custom database
Sourcepub fn from_env() -> Result<Self, String>
pub fn from_env() -> Result<Self, String>
Create from environment variables
Reads:
- SURREALDB_ENDPOINT (required)
- SURREALDB_USERNAME (required)
- SURREALDB_PASSWORD (required)
- SURREALDB_NAMESPACE (optional, default: “aivcs”)
- SURREALDB_DATABASE (optional, default: “main”)
- SURREALDB_ROOT (optional, default: “false”) - set to “true” for root users
Trait Implementations§
Source§impl Clone for CloudConfig
impl Clone for CloudConfig
Source§fn clone(&self) -> CloudConfig
fn clone(&self) -> CloudConfig
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for CloudConfig
impl RefUnwindSafe for CloudConfig
impl Send for CloudConfig
impl Sync for CloudConfig
impl Unpin for CloudConfig
impl UnsafeUnpin for CloudConfig
impl UnwindSafe for CloudConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more