bevy_persistence_database 0.2.8

A persistence and database integration solution for the Bevy game engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

//! Database persistence layer for Bevy ECS

// Re-export the derive macro
pub use bevy_persistence_database_derive::persist;

// modules
pub mod components;
pub mod db;
pub mod plugins;
pub mod query;
pub mod registration;
pub mod resources;
pub mod versioning;

mod persist;

// Public API
pub use plugins::persistence_plugin;

pub use components::Guid;
pub use db::MockDatabaseConnection;
#[cfg(feature = "postgres")]
pub use db::PostgresDbConnection;
pub use db::connection::DatabaseConnectionResource;
#[cfg(feature = "arango")]
pub use db::{ArangoAuthMode, ArangoAuthRefresh, ArangoConnectionConfig, ArangoDbConnection};
pub use db::{
    BEVY_PERSISTENCE_DATABASE_METADATA_FIELD, BEVY_PERSISTENCE_DATABASE_VERSION_FIELD, BEVY_PERSISTENCE_DATABASE_BEVY_TYPE_FIELD, DatabaseConnection,
    DocumentKind, PersistenceError, TransactionOperation, read_kind, read_version,
};
pub use persist::Persist;
pub use plugins::{
    CommitCompleted, CommitStatus, PersistencePluginCore, TriggerCommit,
    persistence_plugin::PersistenceSystemSet,
};
pub use query::{CachePolicy, PersistenceQueryCache, PersistentQuery};
pub use resources::{PersistenceSession, PersistentRes, PersistentResMut, commit, commit_sync};

pub use versioning::VersionManager;

// Re-export for macro use
#[doc(hidden)]
pub use once_cell;

// Convenient prelude for users
pub mod prelude {
    pub use crate::{
        DatabaseConnection, Guid, Persist, PersistenceError, PersistenceSession, persist,
        plugins::{PersistencePluginCore, PersistencePlugins, TriggerCommit},
        query::{FilterExpression, PersistentQuery},
        resources::{PersistentRes, PersistentResMut},
    };
    pub use bevy::prelude::Component;

    #[cfg(feature = "arango")]
    pub use crate::{
        ArangoAuthMode, ArangoAuthRefresh, ArangoConnectionConfig, ArangoDbConnection,
    };

    #[cfg(feature = "postgres")]
    pub use crate::PostgresDbConnection;
}