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 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
use arc_bytes::serde::Bytes;
use serde::{Deserialize, Serialize};
use crate::{
document::Header,
schema::{CollectionName, SerializedCollection},
Error,
};
/// A list of operations to execute as a single unit. If any operation fails,
/// all changes are aborted. Reads that happen while the transaction is in
/// progress will return old data and not block.
#[derive(Clone, Serialize, Deserialize, Default, Debug)]
#[must_use]
pub struct Transaction {
/// The operations in this transaction.
pub operations: Vec<Operation>,
}
impl Transaction {
/// Returns a new, empty transaction.
pub fn new() -> Self {
Self::default()
}
/// Adds an operation to the transaction.
pub fn push(&mut self, operation: Operation) {
self.operations.push(operation);
}
/// Appends an operation to the transaction and returns self.
pub fn with(mut self, operation: Operation) -> Self {
self.push(operation);
self
}
}
impl From<Operation> for Transaction {
fn from(operation: Operation) -> Self {
Self {
operations: vec![operation],
}
}
}
impl Transaction {
/// Inserts a new document with `contents` into `collection`. If `id` is
/// `None` a unique id will be generated. If an id is provided and a
/// document already exists with that id, a conflict error will be returned.
pub fn insert(collection: CollectionName, id: Option<u64>, contents: impl Into<Bytes>) -> Self {
Self::from(Operation::insert(collection, id, contents))
}
/// Updates a document in `collection`.
pub fn update(collection: CollectionName, header: Header, contents: impl Into<Bytes>) -> Self {
Self::from(Operation::update(collection, header, contents))
}
/// Deletes a document from a `collection`.
pub fn delete(collection: CollectionName, header: Header) -> Self {
Self::from(Operation::delete(collection, header))
}
}
/// A single operation performed on a `Collection`.
#[derive(Clone, Serialize, Deserialize, Debug)]
#[must_use]
pub struct Operation {
/// The id of the `Collection`.
pub collection: CollectionName,
/// The command being performed.
pub command: Command,
}
impl Operation {
/// Inserts a new document with `contents` into `collection`. If `id` is
/// `None` a unique id will be generated. If an id is provided and a
/// document already exists with that id, a conflict error will be returned.
pub fn insert(collection: CollectionName, id: Option<u64>, contents: impl Into<Bytes>) -> Self {
Self {
collection,
command: Command::Insert {
id,
contents: contents.into(),
},
}
}
/// Inserts a new document with the serialized representation of `contents`
/// into `collection`. If `id` is `None` a unique id will be generated. If
/// an id is provided and a document already exists with that id, a conflict
/// error will be returned.
pub fn insert_serialized<C: SerializedCollection>(
id: Option<u64>,
contents: &C::Contents,
) -> Result<Self, Error> {
let contents = C::serialize(contents)?;
Ok(Self::insert(C::collection_name(), id, contents))
}
/// Updates a document in `collection`.
pub fn update(collection: CollectionName, header: Header, contents: impl Into<Bytes>) -> Self {
Self {
collection,
command: Command::Update {
header,
contents: contents.into(),
},
}
}
/// Updates a document with the serialized representation of `contents` in
/// `collection`.
pub fn update_serialized<C: SerializedCollection>(
header: Header,
contents: &C::Contents,
) -> Result<Self, Error> {
let contents = C::serialize(contents)?;
Ok(Self::update(C::collection_name(), header, contents))
}
/// Deletes a document from a `collection`.
pub const fn delete(collection: CollectionName, header: Header) -> Self {
Self {
collection,
command: Command::Delete { header },
}
}
}
/// A command to execute within a `Collection`.
#[derive(Clone, Serialize, Deserialize, Debug)]
pub enum Command {
/// Inserts a new document containing `contents`.
Insert {
/// An optional id for the document. If this is `None`, a unique id will
/// be generated. If this is `Some()` and a document already exists with
/// that id, a conflict error will be returned.
id: Option<u64>,
/// The initial contents of the document.
contents: Bytes,
},
/// Update an existing `Document` identified by `id`. `revision` must match
/// the currently stored revision on the `Document`. If it does not, the
/// command fill fail with a `DocumentConflict` error.
Update {
/// The header of the `Document`. The revision must match the current
/// document.
header: Header,
/// The new contents to store within the `Document`.
contents: Bytes,
},
/// Delete an existing `Document` identified by `id`. `revision` must match
/// the currently stored revision on the `Document`. If it does not, the
/// command fill fail with a `DocumentConflict` error.
Delete {
/// The current header of the `Document`.
header: Header,
},
}
/// Information about the result of each `Operation` in a transaction.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub enum OperationResult {
/// An operation succeeded but had no information to output.
Success,
/// A `Document` was updated.
DocumentUpdated {
/// The id of the `Collection` of the updated `Document`.
collection: CollectionName,
/// The header of the updated `Document`.
header: Header,
},
/// A `Document` was deleted.
DocumentDeleted {
/// The id of the `Collection` of the deleted `Document`.
collection: CollectionName,
/// The id of the deleted `Document`.
id: u64,
},
}
/// Details about an executed transaction.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Executed {
/// The id of the transaction.
pub id: u64,
/// A list of containing ids of `Documents` changed.
pub changes: Changes,
}
/// A list of changes.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub enum Changes {
/// A list of changed documents.
Documents(Vec<ChangedDocument>),
/// A list of changed keys.
Keys(Vec<ChangedKey>),
}
impl Changes {
/// Returns the list of documents changed in this transaction, or None if
/// the transaction was not a document transaction.
#[must_use]
pub fn documents(&self) -> Option<&[ChangedDocument]> {
if let Self::Documents(docs) = self {
Some(docs)
} else {
None
}
}
/// Returns the list of keys changed in this transaction, or None if the
/// transaction was not a `KeyValue` transaction.
#[must_use]
pub fn keys(&self) -> Option<&[ChangedKey]> {
if let Self::Keys(keys) = self {
Some(keys)
} else {
None
}
}
}
/// A record of a changed document.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct ChangedDocument {
/// The id of the `Collection` of the changed `Document`.
pub collection: CollectionName,
/// The id of the changed `Document`.
pub id: u64,
/// If the `Document` has been deleted, this will be `true`.
pub deleted: bool,
}
/// A record of a changed `KeyValue` entry.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct ChangedKey {
/// The namespace of the key.
pub namespace: Option<String>,
/// The key that was changed.
pub key: String,
/// True if the key was deleted.
pub deleted: bool,
}