Skip to main content

Client

polybase_client

Struct Client 

Source 
pub struct Client { /* private fields */ }

Implementations§

Source§

impl Client

Source

pub fn new(address: SocketAddr) -> Result<Self>

Examples found in repository?
examples/local_bench.rs (line 12)
5fn main() -> Result<(), Box<dyn std::error::Error>> {
6    let args: Vec<_> = std::env::args().skip(1).collect();
7    assert_eq!(
8        args.len(),
9        3,
10        "ADDRESS PREFIX COUNT on a disposable console"
11    );
12    let client = Client::new(args[0].parse()?)?;
13    let count = args[2].parse::<usize>()?;
14    assert!((1..=128).contains(&count));
15    let query = Query::all(args[1].as_bytes());
16    let session = client.subscribe(&query)?;
17    assert!(session.rows.is_empty());
18    let started = Instant::now();
19    for i in 0..count {
20        let key = format!("{}{i:04}", args[1]);
21        let read = client.read_revision(key.as_bytes())?;
22        assert!(read.value.is_none());
23        let value = json!({"client":"rust","n":i}).to_string();
24        let receipt = client.write_revision(&read.revision, Some(value.as_bytes()))?;
25        assert!(receipt.durable);
26    }
27    let write_us = started.elapsed().as_micros();
28    let started = Instant::now();
29    let page = client.page(&query, None, 128)?;
30    assert_eq!(page.rows.len(), count);
31    let page_us = started.elapsed().as_micros();
32    let started = Instant::now();
33    let delta = client.poll(&session, &session.token)?;
34    assert_eq!(delta.commits.len(), count);
35    let poll_us = started.elapsed().as_micros();
36    client.unsubscribe(&session, &delta.token)?;
37    println!(
38        "{}",
39        json!({"client":"rust","records":count,"revision_read_write_us":write_us,"page_us":page_us,"poll_us":poll_us,"correctness_verified":true})
40    );
41    Ok(())
42}
Source

pub fn call<T: DeserializeOwned>( &self, route: &str, body: &impl Serialize, ) -> Result<T>

A transport error after sending a write leaves its outcome uncertain.

Source

pub fn page( &self, query: &Query, cursor: Option<&str>, limit: usize, ) -> Result<Page>

Examples found in repository?
examples/local_bench.rs (line 29)
5fn main() -> Result<(), Box<dyn std::error::Error>> {
6    let args: Vec<_> = std::env::args().skip(1).collect();
7    assert_eq!(
8        args.len(),
9        3,
10        "ADDRESS PREFIX COUNT on a disposable console"
11    );
12    let client = Client::new(args[0].parse()?)?;
13    let count = args[2].parse::<usize>()?;
14    assert!((1..=128).contains(&count));
15    let query = Query::all(args[1].as_bytes());
16    let session = client.subscribe(&query)?;
17    assert!(session.rows.is_empty());
18    let started = Instant::now();
19    for i in 0..count {
20        let key = format!("{}{i:04}", args[1]);
21        let read = client.read_revision(key.as_bytes())?;
22        assert!(read.value.is_none());
23        let value = json!({"client":"rust","n":i}).to_string();
24        let receipt = client.write_revision(&read.revision, Some(value.as_bytes()))?;
25        assert!(receipt.durable);
26    }
27    let write_us = started.elapsed().as_micros();
28    let started = Instant::now();
29    let page = client.page(&query, None, 128)?;
30    assert_eq!(page.rows.len(), count);
31    let page_us = started.elapsed().as_micros();
32    let started = Instant::now();
33    let delta = client.poll(&session, &session.token)?;
34    assert_eq!(delta.commits.len(), count);
35    let poll_us = started.elapsed().as_micros();
36    client.unsubscribe(&session, &delta.token)?;
37    println!(
38        "{}",
39        json!({"client":"rust","records":count,"revision_read_write_us":write_us,"page_us":page_us,"poll_us":poll_us,"correctness_verified":true})
40    );
41    Ok(())
42}
Source

pub fn page_with_scan( &self, query: &Query, cursor: Option<&str>, limit: usize, force_scan: bool, ) -> Result<Page>

Source

pub fn read_revision(&self, key: &[u8]) -> Result<RevisionRead>

Examples found in repository?
examples/local_bench.rs (line 21)
5fn main() -> Result<(), Box<dyn std::error::Error>> {
6    let args: Vec<_> = std::env::args().skip(1).collect();
7    assert_eq!(
8        args.len(),
9        3,
10        "ADDRESS PREFIX COUNT on a disposable console"
11    );
12    let client = Client::new(args[0].parse()?)?;
13    let count = args[2].parse::<usize>()?;
14    assert!((1..=128).contains(&count));
15    let query = Query::all(args[1].as_bytes());
16    let session = client.subscribe(&query)?;
17    assert!(session.rows.is_empty());
18    let started = Instant::now();
19    for i in 0..count {
20        let key = format!("{}{i:04}", args[1]);
21        let read = client.read_revision(key.as_bytes())?;
22        assert!(read.value.is_none());
23        let value = json!({"client":"rust","n":i}).to_string();
24        let receipt = client.write_revision(&read.revision, Some(value.as_bytes()))?;
25        assert!(receipt.durable);
26    }
27    let write_us = started.elapsed().as_micros();
28    let started = Instant::now();
29    let page = client.page(&query, None, 128)?;
30    assert_eq!(page.rows.len(), count);
31    let page_us = started.elapsed().as_micros();
32    let started = Instant::now();
33    let delta = client.poll(&session, &session.token)?;
34    assert_eq!(delta.commits.len(), count);
35    let poll_us = started.elapsed().as_micros();
36    client.unsubscribe(&session, &delta.token)?;
37    println!(
38        "{}",
39        json!({"client":"rust","records":count,"revision_read_write_us":write_us,"page_us":page_us,"poll_us":poll_us,"correctness_verified":true})
40    );
41    Ok(())
42}
Source

pub fn write_revision( &self, revision: &str, value: Option<&[u8]>, ) -> Result<Receipt>

Examples found in repository?
examples/local_bench.rs (line 24)
5fn main() -> Result<(), Box<dyn std::error::Error>> {
6    let args: Vec<_> = std::env::args().skip(1).collect();
7    assert_eq!(
8        args.len(),
9        3,
10        "ADDRESS PREFIX COUNT on a disposable console"
11    );
12    let client = Client::new(args[0].parse()?)?;
13    let count = args[2].parse::<usize>()?;
14    assert!((1..=128).contains(&count));
15    let query = Query::all(args[1].as_bytes());
16    let session = client.subscribe(&query)?;
17    assert!(session.rows.is_empty());
18    let started = Instant::now();
19    for i in 0..count {
20        let key = format!("{}{i:04}", args[1]);
21        let read = client.read_revision(key.as_bytes())?;
22        assert!(read.value.is_none());
23        let value = json!({"client":"rust","n":i}).to_string();
24        let receipt = client.write_revision(&read.revision, Some(value.as_bytes()))?;
25        assert!(receipt.durable);
26    }
27    let write_us = started.elapsed().as_micros();
28    let started = Instant::now();
29    let page = client.page(&query, None, 128)?;
30    assert_eq!(page.rows.len(), count);
31    let page_us = started.elapsed().as_micros();
32    let started = Instant::now();
33    let delta = client.poll(&session, &session.token)?;
34    assert_eq!(delta.commits.len(), count);
35    let poll_us = started.elapsed().as_micros();
36    client.unsubscribe(&session, &delta.token)?;
37    println!(
38        "{}",
39        json!({"client":"rust","records":count,"revision_read_write_us":write_us,"page_us":page_us,"poll_us":poll_us,"correctness_verified":true})
40    );
41    Ok(())
42}
Source

pub fn subscribe(&self, query: &Query) -> Result<Session>

Examples found in repository?
examples/local_bench.rs (line 16)
5fn main() -> Result<(), Box<dyn std::error::Error>> {
6    let args: Vec<_> = std::env::args().skip(1).collect();
7    assert_eq!(
8        args.len(),
9        3,
10        "ADDRESS PREFIX COUNT on a disposable console"
11    );
12    let client = Client::new(args[0].parse()?)?;
13    let count = args[2].parse::<usize>()?;
14    assert!((1..=128).contains(&count));
15    let query = Query::all(args[1].as_bytes());
16    let session = client.subscribe(&query)?;
17    assert!(session.rows.is_empty());
18    let started = Instant::now();
19    for i in 0..count {
20        let key = format!("{}{i:04}", args[1]);
21        let read = client.read_revision(key.as_bytes())?;
22        assert!(read.value.is_none());
23        let value = json!({"client":"rust","n":i}).to_string();
24        let receipt = client.write_revision(&read.revision, Some(value.as_bytes()))?;
25        assert!(receipt.durable);
26    }
27    let write_us = started.elapsed().as_micros();
28    let started = Instant::now();
29    let page = client.page(&query, None, 128)?;
30    assert_eq!(page.rows.len(), count);
31    let page_us = started.elapsed().as_micros();
32    let started = Instant::now();
33    let delta = client.poll(&session, &session.token)?;
34    assert_eq!(delta.commits.len(), count);
35    let poll_us = started.elapsed().as_micros();
36    client.unsubscribe(&session, &delta.token)?;
37    println!(
38        "{}",
39        json!({"client":"rust","records":count,"revision_read_write_us":write_us,"page_us":page_us,"poll_us":poll_us,"correctness_verified":true})
40    );
41    Ok(())
42}
Source

pub fn resume(&self, token: &str) -> Result<ResumedSession>

Source

pub fn poll( &self, session: &impl SessionIdentity, applied_token: &str, ) -> Result<StreamPage>

Supply the last applied token; persist rows and this token atomically in the application.

Examples found in repository?
examples/local_bench.rs (line 33)
5fn main() -> Result<(), Box<dyn std::error::Error>> {
6    let args: Vec<_> = std::env::args().skip(1).collect();
7    assert_eq!(
8        args.len(),
9        3,
10        "ADDRESS PREFIX COUNT on a disposable console"
11    );
12    let client = Client::new(args[0].parse()?)?;
13    let count = args[2].parse::<usize>()?;
14    assert!((1..=128).contains(&count));
15    let query = Query::all(args[1].as_bytes());
16    let session = client.subscribe(&query)?;
17    assert!(session.rows.is_empty());
18    let started = Instant::now();
19    for i in 0..count {
20        let key = format!("{}{i:04}", args[1]);
21        let read = client.read_revision(key.as_bytes())?;
22        assert!(read.value.is_none());
23        let value = json!({"client":"rust","n":i}).to_string();
24        let receipt = client.write_revision(&read.revision, Some(value.as_bytes()))?;
25        assert!(receipt.durable);
26    }
27    let write_us = started.elapsed().as_micros();
28    let started = Instant::now();
29    let page = client.page(&query, None, 128)?;
30    assert_eq!(page.rows.len(), count);
31    let page_us = started.elapsed().as_micros();
32    let started = Instant::now();
33    let delta = client.poll(&session, &session.token)?;
34    assert_eq!(delta.commits.len(), count);
35    let poll_us = started.elapsed().as_micros();
36    client.unsubscribe(&session, &delta.token)?;
37    println!(
38        "{}",
39        json!({"client":"rust","records":count,"revision_read_write_us":write_us,"page_us":page_us,"poll_us":poll_us,"correctness_verified":true})
40    );
41    Ok(())
42}
Source

pub fn unsubscribe( &self, session: &impl SessionIdentity, token: &str, ) -> Result<Value>

Examples found in repository?
examples/local_bench.rs (line 36)
5fn main() -> Result<(), Box<dyn std::error::Error>> {
6    let args: Vec<_> = std::env::args().skip(1).collect();
7    assert_eq!(
8        args.len(),
9        3,
10        "ADDRESS PREFIX COUNT on a disposable console"
11    );
12    let client = Client::new(args[0].parse()?)?;
13    let count = args[2].parse::<usize>()?;
14    assert!((1..=128).contains(&count));
15    let query = Query::all(args[1].as_bytes());
16    let session = client.subscribe(&query)?;
17    assert!(session.rows.is_empty());
18    let started = Instant::now();
19    for i in 0..count {
20        let key = format!("{}{i:04}", args[1]);
21        let read = client.read_revision(key.as_bytes())?;
22        assert!(read.value.is_none());
23        let value = json!({"client":"rust","n":i}).to_string();
24        let receipt = client.write_revision(&read.revision, Some(value.as_bytes()))?;
25        assert!(receipt.durable);
26    }
27    let write_us = started.elapsed().as_micros();
28    let started = Instant::now();
29    let page = client.page(&query, None, 128)?;
30    assert_eq!(page.rows.len(), count);
31    let page_us = started.elapsed().as_micros();
32    let started = Instant::now();
33    let delta = client.poll(&session, &session.token)?;
34    assert_eq!(delta.commits.len(), count);
35    let poll_us = started.elapsed().as_micros();
36    client.unsubscribe(&session, &delta.token)?;
37    println!(
38        "{}",
39        json!({"client":"rust","records":count,"revision_read_write_us":write_us,"page_us":page_us,"poll_us":poll_us,"correctness_verified":true})
40    );
41    Ok(())
42}
Source

pub fn snapshot_at(&self, position: u64) -> Result<Value>

Source

pub fn backup(&self, directory: &str) -> Result<Value>

Source

pub fn verify_backup(&self, directory: &str) -> Result<Value>

Source

pub fn create_index( &self, name: &str, prefix: &[u8], path: &[&str], ) -> Result<Value>

This route takes prefix bytes as a JSON array, unlike hex key_prefix fields.

Source

pub fn indexes(&self) -> Result<Value>

Source

pub fn search_index(&self, name: &str, value: Value) -> Result<SearchResult>

Source

pub fn drop_index(&self, name: &str) -> Result<Value>

Source

pub fn compaction_advice(&self, retain_commits: u64) -> Result<Value>

Source

pub fn search(&self, query: &SearchQuery) -> Result<SearchResult>

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.