Crate unofficial_appwrite

Expand description

§Unofficial Appwrite

unofficial_appwrite was created to help developers interested in using appwrite for their rust web servers.

Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Dart SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to https://appwrite.io/docs

§Initialize & Make API Request


use unofficial_appwrite::client::ClientBuilder;
use unofficial_appwrite::error::Error;
use unofficial_appwrite::services::server::users::Users;
use unofficial_appwrite::id::ID;

#[tokio::main]
async fn main() -> Result<(), Error> {
   let  client = ClientBuilder::default()
   .set_endpoint("http://[HOSTNAME_OR_IP]/v1") // Make sure your endpoint is accessible
   .set_project("5ff3...")? // Your project ID
   .set_key("cd868c7af8bdc893b4...93b7535db89")?
   //.set_self_signed(false)? // Use only on dev mode with a self-signed SSL cert
   .build()?;

let create_user = Users::create(
       &client,
       ID::unique(),
       Some("email@example.com"),
       None,
       Some("password"),
       Some("Walter O'Brien"),
   )
   .await?;
   dbg!("{:?}", create_user);
}

§User Examples


use unofficial_appwrite::client::ClientBuilder;
use unofficial_appwrite::error::Error;
use unofficial_appwrite::services::server::users::Users;
use serde_json::{json, Map};

#[tokio::main]
async fn main() -> Result<(), Error> {
   let  client = ClientBuilder::default()
   .set_endpoint("http://[HOSTNAME_OR_IP]/v1") // Make sure your endpoint is accessible
   .set_project("5ff3...")? // Your project ID
   .set_key("cd868c7af8bdc893b4...93b7535db89")?
   //.set_self_signed(false)? // Use only on dev mode with a self-signed SSL cert
   .build()?;

let user_prefs = Users::get_prefs(&client, "6...64").await?;
   dbg!("{:#?}", user_prefs);

   let mut prefs = Map::new();
   prefs.insert("isAdmin".to_string(), json!(true));
   let user_update_prefs = Users::update_prefs(&client, "6...4", prefs).await?;
   dbg!("{:#?}", user_update_prefs);
}

§Database Examples

use unofficial_appwrite::client::ClientBuilder;
use unofficial_appwrite::error::Error;
use serde_json::{json, Map};
use unofficial_appwrite::id::ID;
use unofficial_appwrite::services::server::databases::Databases;
use unofficial_appwrite::permission::Permission;
use unofficial_appwrite::enums::relationship_type::RelationshipType;
use unofficial_appwrite::query::Query;

#[tokio::main]
async fn main() -> Result<(), Error> {

    let  client = ClientBuilder::default()
   .set_endpoint("http://[HOSTNAME_OR_IP]/v1") // Make sure your endpoint is accessible
   .set_project("5ff3379a01d25")? // Your project ID
   .set_key("cd868c7af8bdc893b4...93b7535db89")?
   //.set_self_signed(false)? // Use only on dev mode with a self-signed SSL cert
   .build()?;

    let create_db = Databases::create(&client, ID::unique(), "test_db", None).await?;
   dbg!(create_db);

   let create_collection = Databases::create_collection(
       &client,"6618...76",ID::unique(),"test_collection_1",
       Some(vec![
           Permission::read("any"),
           Permission::create("user:22222346"),
       ]),
       None,None,).await?;
   dbg!(create_collection);

   let att = Databases::create_boolean_attribute(
       &client,"6618...76","6618...d4","isAdmin",true,None,None,).await?;
   dbg!(att);
   let name = Databases::create_string_attribute(
       &client,"6618...76","6618...d4","title",255,true,None,None,None,).await?;
   dbg!(name);

   let mut data = Map::new();
   data.insert(String::from("isAdmin"), json!(false));
   data.insert(String::from("title"), json!("next1"));
   let create_doc = Databases::create_documents(
       &client,"6618...76","6618...d4",ID::unique(),data,None,).await?;
   dbg!(create_doc);

   let relationship = Databases::create_relationship_attribute(
       &client,"6618...76","6618...d4","6619...1e",
       RelationshipType::OneToOne,
       None,Some("test_col_2"),None,None,).await?;
   dbg!(relationship);

    let queries = vec![Query::equal(r"$id", json!(vec!["6618ef06d269bf4110d4"]))];

    let col_list = Databases::list_collections(
        &client,
        "6618eec286a4ef198076",
        Some(Query::equal(r"$id", json!(vec!["6619010ddab914e6b01e"]))),
        Some(queries),
    )
    .await?;
    dbg!(col_list);
}

§Storage Examples

use unofficial_appwrite::client::ClientBuilder;
use unofficial_appwrite::error::Error;
use unofficial_appwrite::id::ID;
use unofficial_appwrite::services::server::storage::Storage;
use futures_util::{pin_mut, StreamExt};
use std::fs;

#[tokio::main]
async fn main() -> Result<(), Error> {

     let  client = ClientBuilder::default()
    .set_endpoint("http://[HOSTNAME_OR_IP]/v1") // Make sure your endpoint is accessible
    .set_project("5ff3379a01d25")? // Your project ID
    .set_key("cd868c7af8bdc893b4...93b7535db89")?
    //.set_self_signed(false)? // Use only on dev mode with a self-signed SSL cert
    .build()?;

let create_buk = Storage::create_bucket(
        &client,ID::unique(),"My Bucket",None,None,None,None,None,None,None,None,).await?;
    dbg!(create_buk);

   let create_file_with_no_progress = Storage::create_files(
   &client,
   "65d20d5c8096032a03cd",
   ID::unique(),
   r"c:\Users\pc\Downloads\Video\New folder (2)\Folder 1\Ultimate Flutter for Cross-Platform App Development (Temidayo Adefioye) (Z-Library).pdf",
   String::from("sgs_deadlines_next.pdf"),
   None,
   )
   .await?;
   dbg!(create_file_with_no_progress);
   
   //or
   let create_file_and_stream_upload_progress = Storage::create_files_streamed(
   &client,
   "65d20d5c8096032a03cd",
   ID::unique(),
   r"c:\Users\pc\Downloads\Video\New folder (2)\Folder 1\Ultimate Flutter for Cross-Platform App Development (Temidayo Adefioye) (Z-Library).pdf",
   String::from("sgs_deadlines_next_3.pdf"),
   None,
   )
   .await;
   pin_mut!(create_file_and_stream_upload_progress);
   while let Some(data) = create_file_and_stream_upload_progress.next().await {
   let res = data.unwrap();
   let file = res.0;
   println!("==>{:?}===>{:?}", file, res.1);
   }

    let get_file =
        Storage::get_file(&client, "661...e9", "661...71e").await?;
    dbg!(get_file);

    let get_file_download =
        Storage::get_file_download(&client, "661...e9", "661...71e").await?;
    fs::write(
        r"C:\Users\pc\Downloads\Documents\test\second\new.mp4",
        get_file_download,
    )
    .expect("didn't work");
}

§Realtime

use futures_util::{pin_mut, StreamExt};
use unofficial_appwrite::{client::ClientBuilder, error::Error, realtime::RealTime};

#[tokio::main]
async fn main() -> Result<(), Error> {

     let  client = ClientBuilder::default()
    .set_endpoint("http://[HOSTNAME_OR_IP]/v1") // Make sure your endpoint is accessible
    .set_project("5ff3...")? // Your project ID
    .set_key("cd868c7af8bdc893b4...93b7535db89")?
    //.set_self_signed(false)? // Use only on dev mode with a self-signed SSL cert
    .build()?;

 let stream = RealTime::subscribe(
        &client,
        vec!["databases.6618eec286a4ef198076.collections.6618ef06d269bf4110d4.documents"],
    )
    .await;
    pin_mut!(stream);
    while let Some(data) = stream.next().await {
        println!("=====>{:?}<=====", data);
    }
}

§Utilities

§Queries

    use unofficial_appwrite::query::Query;
    Query::equal(r"$id", json!(vec!["6618ef06d269bf4110d4"]))

§Id

    use unofficial_appwrite::id::ID;
    ID::unique();

§Permission

    use unofficial_appwrite::permission::Permission;
    Permission::read("any"),
    Permission::create("user:22222346"),

§Role

    use unofficial_appwrite::role::Role;
    Role::any()

NOTE 🎶: for other examples. check out the official docs or sdk of official sdk as a guide to using this sdk.

Crate unofficial_appwriteCopy item path