query method for store API

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Introduce libp2p networking service and configuration [#282](https://github.com/p2panda/aquadoggo/pull/282)
 - Create and validate abstract queries [#302](https://github.com/p2panda/aquadoggo/pull/302)
 - Support paginated, ordered and filtered collection queries [#308](https://github.com/p2panda/aquadoggo/pull/308)
+- SQL query for collections [#311](https://github.com/p2panda/aquadoggo/pull/311)
 - Add custom validation to GraphQL scalar types [#318](https://github.com/p2panda/aquadoggo/pull/318)
 
 ### Changed

aquadoggo/Cargo.toml

@@ -22,6 +22,7 @@ async-graphql-axum = "^5.0.6"
 async-trait = "^0.1.64"
 axum = "^0.6.10"
 bamboo-rs-core-ed25519-yasmf = "^0.1.1"
+bs58 = "^0.4.0"
 deadqueue = { version = "^0.2.3", default-features = false, features = [
     "unlimited",
 ] }

aquadoggo/migrations/20220509090252_create-operations.sql

@@ -15,7 +15,7 @@ CREATE TABLE IF NOT EXISTS operation_fields_v1 (
     name                    TEXT             NOT NULL,
     field_type              TEXT             NOT NULL,
     value                   TEXT             NULL,
-    list_index              NUMERIC          NOT NULL,
+    list_index              INT              NOT NULL,
     FOREIGN KEY(operation_id) REFERENCES operations_v1(operation_id)
 );
 

aquadoggo/migrations/20230420121200_alter-operation-fields.sql

@@ -0,0 +1,5 @@
+-- SPDX-License-Identifier: AGPL-3.0-or-later
+
+ALTER TABLE operation_fields_v1 ADD COLUMN cursor TEXT NOT NULL;
+
+CREATE UNIQUE INDEX ux_operation_fields_v1 ON operation_fields_v1 (cursor);

aquadoggo/src/db/models/document.rs

@@ -5,37 +5,43 @@ use sqlx::FromRow;
 /// A struct representing a single row with joins from the document_view_fields table.
 #[derive(FromRow, Debug, Clone)]
 pub struct DocumentViewFieldRow {
-    /// The id of this operation.
+    /// Id of the document.
+    pub document_id: String,
+
+    /// Id of the view id representing the document version with this field value.
     pub document_view_id: String,
 
-    /// The id of this operation.
+    /// Id of operation which set that field value.
     pub operation_id: String,
 
-    /// The name of this field.
+    /// Name of field.
     pub name: String,
 
-    /// The type of this field.
+    /// Position index of value when it is in a relation list.
+    pub list_index: i32,
+
+    /// Type of field.
     pub field_type: String,
 
-    /// The actual value contained in this field.
+    /// Actual value contained in field.
     pub value: String,
 }
 
 /// A struct representing a single row of a document table.
 #[derive(FromRow, Debug, Clone)]
 pub struct DocumentRow {
-    /// The id of this document
+    /// Id of this document
     pub document_id: String,
 
-    /// The id of this documents most recent view.
+    /// Id of this documents most recent view.
     pub document_view_id: String,
 
-    /// The id of the author of this document.
-    pub public_key: String,
-
-    /// The id of this documents schema.
+    /// Id of this documents schema.
     pub schema_id: String,
 
+    /// Author of this document.
+    pub public_key: String,
+
     /// Flag for if this document is deleted.
     pub is_deleted: bool,
 }

aquadoggo/src/db/models/mod.rs

@@ -6,11 +6,13 @@ mod document;
 mod entry;
 mod log;
 mod operation;
+mod query;
 mod task;
 pub mod utils;
 
 pub use self::log::LogRow;
 pub use document::{DocumentRow, DocumentViewFieldRow};
 pub use entry::EntryRow;
 pub use operation::{OperationFieldsJoinedRow, OperationRow};
+pub use query::{OptionalOwner, QueryRow};
 pub use task::TaskRow;

aquadoggo/src/db/models/operation.rs

@@ -47,6 +47,14 @@ pub struct OperationFieldRow {
     ///
     /// This is an Option as a DELETE operation contains no fields.
     pub value: Option<String>,
+
+    /// Index of document id or view id in (pinned) relation lists.
+    ///
+    /// This numeric value is a simple list index to represent multiple values within one operation
+    /// field.
+    ///
+    /// This is an Option as a DELETE operation contains no fields.
+    pub list_index: Option<i32>,
 }
 
 /// A struct representing a joined OperationRow and OperationFieldRow.
@@ -85,4 +93,10 @@ pub struct OperationFieldsJoinedRow {
     ///
     /// This is an Option as a DELETE operation contains no fields.
     pub value: Option<String>,
+
+    /// Index of document id or view id in (pinned) relation lists.
+    ///
+    /// This numeric value is a simple list index to represent multiple values within one operation
+    /// field.
+    pub list_index: Option<i32>,
 }

aquadoggo/src/db/models/query.rs

@@ -0,0 +1,79 @@
+// SPDX-License-Identifier: AGPL-3.0-or-later
+
+use p2panda_rs::identity::PublicKey;
+use sqlx::{FromRow, Type};
+
+/// Resulting row of a custom SQL query for filtered, ordered and paginated collection requests
+/// against the database.
+///
+/// Some fields will be set to default values when they have not been included in the SQL query.
+#[derive(FromRow, Debug, Clone)]
+pub struct QueryRow {
+    /// Id of the document the operation is part of.
+    pub document_id: String,
+
+    /// Latest view id of the document.
+    pub document_view_id: String,
+
+    /// Id of the operation which contains that field value.
+    pub operation_id: String,
+
+    /// Flag if document is deleted.
+    pub is_deleted: bool,
+
+    /// Unique identifier aiding cursor-based pagination.
+    ///
+    /// This value gets especially useful if we need to paginate over duplicate documents.
+    pub cmp_value_cursor: String,
+
+    #[sqlx(default)]
+    pub root_cursor: String,
+
+    /// Flag if document was at least changed once (more than one operation).
+    #[sqlx(default)]
+    pub is_edited: bool,
+
+    /// Public key of original author of document / CREATE operation.
+    #[sqlx(default)]
+    pub owner: OptionalOwner,
+
+    /// Name of the application field value we're interested in.
+    #[sqlx(default)]
+    pub name: String,
+
+    /// Application field value.
+    #[sqlx(default)]
+    pub value: String,
+
+    /// Type of the application field (string, boolean, float, int, relation etc.).
+    #[sqlx(default)]
+    pub field_type: String,
+
+    /// Special index value for (pinned) relation list fields which can contain multiple values.
+    /// The order of these values is crucial and needs to be preserved by keeping the index around.
+    #[sqlx(default)]
+    pub list_index: i32,
+}
+
+/// Wrapper around a public key, represented as a string in the database.
+///
+/// Since other structs assume that there is always a public key set, we have this wrapper type to
+/// give a default "fake" public key, even when it was not returned by the SQL query.
+#[derive(Type, Debug, Clone)]
+#[sqlx(transparent)]
+pub struct OptionalOwner(String);
+
+impl From<&OptionalOwner> for PublicKey {
+    fn from(value: &OptionalOwner) -> Self {
+        // Unwrap here since we assume that public key was already validated before it was stored
+        // in database
+        value.0.parse().unwrap()
+    }
+}
+
+impl Default for OptionalOwner {
+    fn default() -> Self {
+        // "Fake" ed25519 public key serving as a placeholder when it was not requested in query
+        Self("0000000000000000000000000000000000000000000000000000000000000000".to_string())
+    }
+}