-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
mutations via native queries #7
Merged
Merged
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
1ef17e1
add configuration for native queries; report queries in schema response
hallettj 029ff0f
read schema and native queries from separate files
hallettj 9ebfc75
rename metadata to schema
hallettj b6f6258
update fixture configuration
hallettj 039c840
succeed parsing configuration if no native_queries are present
hallettj 12e7b33
add mode property to NativeQuery
hallettj 5962ae5
represent native queries as functions and procedures in schema
hallettj b995bee
Merge branch 'main' into jesse/native-queries
hallettj 178695a
execute native query
hallettj c608d17
updated fixtures with a very basic native query
hallettj e9f042f
add more context to configuration read errors
hallettj f5d4f62
add objectTypes field to native queries
hallettj 5385363
update fixtures with object types
hallettj 1238cc6
Merge branch 'main' into jesse/native-queries-in-query-handler
hallettj e6b32b1
fix a typo
hallettj 0d098d3
check for duplicate names when parsing configuration
hallettj 4100fd7
implementation for read-write native queries
hallettj 6af42b6
remove fields from Job if we're not going to use it
hallettj a092d72
add example mutation, insertArtist, in fixtures
hallettj 9189bdf
Merge branch 'main' into jesse/mutations-via-native-queries
hallettj 3c7e9df
fixture was inserting two documents
hallettj File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
use std::collections::BTreeMap; | ||
|
||
use configuration::native_queries::NativeQuery; | ||
use futures::future::try_join_all; | ||
use itertools::Itertools; | ||
use mongodb::Database; | ||
use mongodb_agent_common::interface_types::MongoConfig; | ||
use ndc_sdk::{ | ||
connector::MutationError, | ||
json_response::JsonResponse, | ||
models::{MutationOperation, MutationOperationResults, MutationRequest, MutationResponse}, | ||
}; | ||
use serde_json::Value; | ||
|
||
/// A procedure combined with inputs | ||
#[derive(Clone, Debug)] | ||
#[allow(dead_code)] | ||
struct Job<'a> { | ||
// For the time being all procedures are native queries. | ||
native_query: &'a NativeQuery, | ||
arguments: BTreeMap<String, Value>, | ||
} | ||
|
||
impl<'a> Job<'a> { | ||
pub fn new(native_query: &'a NativeQuery, arguments: BTreeMap<String, Value>) -> Self { | ||
Job { | ||
native_query, | ||
arguments, | ||
} | ||
} | ||
} | ||
|
||
pub async fn handle_mutation_request( | ||
config: &MongoConfig, | ||
mutation_request: MutationRequest, | ||
) -> Result<JsonResponse<MutationResponse>, MutationError> { | ||
tracing::debug!(?config, mutation_request = %serde_json::to_string(&mutation_request).unwrap(), "executing mutation"); | ||
let database = config.client.database(&config.database); | ||
let jobs = look_up_procedures(config, mutation_request)?; | ||
let operation_results = try_join_all( | ||
jobs.into_iter() | ||
.map(|job| execute_job(database.clone(), job)), | ||
) | ||
.await?; | ||
Ok(JsonResponse::Value(MutationResponse { operation_results })) | ||
} | ||
|
||
/// Looks up procedures according to the names given in the mutation request, and pairs them with | ||
/// arguments and requested fields. Returns an error if any procedures cannot be found. | ||
fn look_up_procedures( | ||
config: &MongoConfig, | ||
mutation_request: MutationRequest, | ||
) -> Result<Vec<Job<'_>>, MutationError> { | ||
let (jobs, not_found): (Vec<Job>, Vec<String>) = mutation_request | ||
.operations | ||
.into_iter() | ||
.map(|operation| match operation { | ||
MutationOperation::Procedure { | ||
name, arguments, .. | ||
} => { | ||
let native_query = config | ||
.native_queries | ||
.iter() | ||
.find(|native_query| native_query.name == name); | ||
native_query.ok_or(name).map(|nq| Job::new(nq, arguments)) | ||
} | ||
}) | ||
.partition_result(); | ||
|
||
if !not_found.is_empty() { | ||
return Err(MutationError::UnprocessableContent(format!( | ||
"request includes unknown procedures: {}", | ||
not_found.join(", ") | ||
))); | ||
} | ||
|
||
Ok(jobs) | ||
} | ||
|
||
async fn execute_job( | ||
database: Database, | ||
job: Job<'_>, | ||
) -> Result<MutationOperationResults, MutationError> { | ||
let result = database | ||
.run_command(job.native_query.command.clone(), None) | ||
.await | ||
.map_err(|err| match *err.kind { | ||
mongodb::error::ErrorKind::InvalidArgument { message, .. } => { | ||
MutationError::UnprocessableContent(message) | ||
} | ||
err => MutationError::Other(Box::new(err)), | ||
})?; | ||
let json_result = | ||
serde_json::to_value(result).map_err(|err| MutationError::Other(Box::new(err)))?; | ||
Ok(MutationOperationResults::Procedure { | ||
result: json_result, | ||
}) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,5 @@ | ||
name: hello | ||
description: Example of a read-only native query | ||
objectTypes: | ||
- name: HelloResult | ||
fields: | ||
|
16 changes: 16 additions & 0 deletions
16
fixtures/connector/chinook/native_queries/insert_artist.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
name: insertArtist | ||
description: Example of a database update using a native query | ||
objectTypes: | ||
- name: InsertArtist | ||
fields: | ||
- name: ok | ||
type: !scalar int | ||
- name: n | ||
type: !scalar int | ||
resultType: !object InsertArtist | ||
# TODO: implement arguments instead of hard-coding inputs | ||
command: | ||
insert: "Artist" | ||
documents: | ||
- ArtistId: 1001 | ||
Name: Regina Spektor |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
kind: Command | ||
version: v1 | ||
definition: | ||
name: insertArtist | ||
description: Example of a database update using a native query | ||
outputType: InsertArtist | ||
arguments: [] | ||
source: | ||
dataConnectorName: mongodb | ||
dataConnectorCommand: | ||
procedure: insertArtist | ||
typeMapping: | ||
InsertArtist: | ||
fieldMapping: | ||
ok: { column: ok } | ||
n: { column: n } | ||
graphql: | ||
rootFieldName: insertArtist | ||
rootFieldKind: Mutation | ||
|
||
--- | ||
kind: CommandPermissions | ||
version: v1 | ||
definition: | ||
commandName: insertArtist | ||
permissions: | ||
- role: admin | ||
allowExecution: true | ||
|
||
--- | ||
kind: ObjectType | ||
version: v1 | ||
definition: | ||
name: InsertArtist | ||
graphql: | ||
typeName: InsertArtist | ||
fields: | ||
- name: ok | ||
type: Int! | ||
- name: n | ||
type: Int! | ||
|
||
--- | ||
kind: TypePermissions | ||
version: v1 | ||
definition: | ||
typeName: InsertArtist | ||
permissions: | ||
- role: admin | ||
output: | ||
allowedFields: | ||
- ok | ||
- n | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See my comment on PR #5. We will want a more performant way to look up native queries than linear search. This is within a
map
now so potentially O(m * n) where m is the number of operations and n is the number of native queries.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, I filed https://hasurahq.atlassian.net/browse/MDB-91 to follow up