Giter VIP home page Giter VIP logo

database-reflection's Introduction

Crates.io API dependency status build and test codecov

database-reflection

Collection of Rust structs and traits to construct a high-level database reflection.
Currently under development. Subject to breaking changes and documentation struggles.

For the time being the library supports only MariaDB with InnoDB table engine.
Could theoretically work with MySQL and InnoDB but that is not confirmed as of time of writing.

Use at your own risk. Still under development.

Quick Start

Manual Construction

Take a look at test integration.rs to see how to build "by hand".

    use database_reflection::reflection::Database;

    let db_name = "test"; 
    let mut db = Database::new(db_name);

    // and so on...

Using Reflection Adapter

If your database is designed by the convention this library expects, you may hope to be able to build a reflection using the provided reflection adapter for MariaDB.
Note: this requires the mariadb feature to be enabled.

    use database_reflection::adapter::mariadb_innodb::MariadbInnodbReflectionAdapter;
    use database_reflection::adapter::reflection_adapter::{ReflectionAdapter, ReflectionAdapterUninitialized};
    use database_reflection::reflection::{Column, Constraint, Database, DefaultValue, Index, SqlDatatype, Table};

    dotenvy::dotenv()?;
    let connection_str = env::var("DB_CONNECTION")?;
    let reflection = MariadbInnodbReflectionAdapter::new(&connection_str).connect().await?.get_reflection().await?;

Note: connection_str is a standard DSN.

License

This library (database-reflection) is open sourced under the MIT License.

database-reflection's People

Contributors

iganev avatar

Stargazers

Sumit Datta avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.