Multiple Create - Database Query Generation and Selection Set Resolution

config-generators/mssql-commands.txt

@@ -1,14 +1,19 @@
 init --config "dab-config.MsSql.json" --database-type mssql --set-session-context true --connection-string "Server=tcp:127.0.0.1,1433;Persist Security Info=False;User ID=sa;Password=REPLACEME;MultipleActiveResultSets=False;Connection Timeout=5;" --host-mode Development --cors-origin "http://localhost:5000" --graphql.multiple-create.enabled true
 add Publisher --config "dab-config.MsSql.json" --source publishers --permissions "anonymous:read"
+add Publisher_MM --config "dab-config.MsSql.json" --source publishers_mm --graphql "Publisher_MM:Publishers_MM" --permissions "anonymous:*"
 add Stock --config "dab-config.MsSql.json" --source stocks --permissions "anonymous:create,read,update,delete"
 add Book --config "dab-config.MsSql.json" --source books --permissions "anonymous:create,read,update,delete" --graphql "book:books"
+add Book_MM --config "dab-config.MsSql.json" --source books_mm --permissions "anonymous:*" --graphql "book_mm:books_mm"
 add BookWebsitePlacement --config "dab-config.MsSql.json" --source book_website_placements --permissions "anonymous:read"
 add Author --config "dab-config.MsSql.json" --source authors --permissions "anonymous:read"
+add Author_MM --config "dab-config.MsSql.json" --source authors_mm --graphql "author_mm:authors_mm" --permissions "anonymous:*"
 add Revenue --config "dab-config.MsSql.json" --source revenues --permissions "anonymous:*"
 add Review --config "dab-config.MsSql.json" --source reviews --permissions "anonymous:create,read,update" --rest true --graphql "review:reviews"
+add Review_MM --config "dab-config.MsSql.json" --source reviews_mm --permissions "anonymous:*" --rest true --graphql "review_mm:reviews_mm"
 add Comic --config "dab-config.MsSql.json" --source comics --permissions "anonymous:create,read,update"
 add Broker --config "dab-config.MsSql.json" --source brokers --permissions "anonymous:read"
 add WebsiteUser --config "dab-config.MsSql.json" --source website_users --permissions "anonymous:create,read,delete,update"
+add WebsiteUser_MM --config "dab-config.MsSql.json" --source website_users_mm --graphql "websiteuser_mm:websiteusers_mm" --permissions "anonymous:*"
 add SupportedType --config "dab-config.MsSql.json" --source type_table --permissions "anonymous:create,read,delete,update"
 add stocks_price --config "dab-config.MsSql.json" --source stocks_price --permissions "authenticated:create,read,update,delete"
 update stocks_price --config "dab-config.MsSql.json" --permissions "anonymous:read"
@@ -71,6 +76,9 @@ update Publisher --config "dab-config.MsSql.json" --permissions "policy_tester_0
 update Publisher --config "dab-config.MsSql.json" --permissions "database_policy_tester:read" --policy-database "@item.id ne 1234 or @item.id gt 1940"
 update Publisher --config "dab-config.MsSql.json" --permissions "database_policy_tester:update" --policy-database "@item.id ne 1234"
 update Publisher --config "dab-config.MsSql.json" --permissions "database_policy_tester:create" --policy-database "@item.name ne 'New publisher'"
+update Publisher --config "dab-config.MsSql.json" --permissions "role_multiple_create_policy_tester:create" --policy-database "@item.name ne 'Test'"
+update Publisher --config "dab-config.MsSql.json" --permissions "role_multiple_create_policy_tester:read,update,delete"
+update Publisher_MM --config "dab-config.MsSql.json" --permissions "authenticated:*" --relationship books_mm --relationship.fields "id:publisher_id" --target.entity Book_MM --cardinality many
 update Stock --config "dab-config.MsSql.json" --permissions "authenticated:create,read,update,delete"
 update Stock --config "dab-config.MsSql.json" --permissions "test_role_with_excluded_fields_on_create:read,update,delete"
 update Stock --config "dab-config.MsSql.json" --permissions "test_role_with_excluded_fields_on_create:create" --fields.exclude "piecesAvailable"
@@ -112,12 +120,27 @@ update Book --config "dab-config.MsSql.json" --permissions "test_role_with_exclu
 update Book --config "dab-config.MsSql.json" --permissions "test_role_with_excluded_fields:read" --fields.exclude "publisher_id"
 update Book --config "dab-config.MsSql.json" --permissions "test_role_with_policy_excluded_fields:create,update,delete"
 update Book --config "dab-config.MsSql.json" --permissions "test_role_with_policy_excluded_fields:read" --fields.exclude "publisher_id" --policy-database "@item.title ne 'Test'"
+update Book --config "dab-config.MsSql.json" --permissions "role_multiple_create_policy_tester:read" --policy-database "@item.publisher_id ne 1234"
+update Book --config "dab-config.MsSql.json" --permissions "role_multiple_create_policy_tester:create" --policy-database "@item.title ne 'Test'"
+update Book --config "dab-config.MsSql.json" --permissions "role_multiple_create_policy_tester:update,delete"
+update Book_MM --config "dab-config.MsSql.json" --permissions "authenticated:*"
+update Book_MM --config "dab-config.MsSql.json" --relationship publishers --target.entity Publisher_MM --cardinality one --relationship.fields "publisher_id:id"
+update Book_MM --config "dab-config.MsSql.json" --relationship reviews --target.entity Review_MM --cardinality many --relationship.fields "id:book_id"
+update Book_MM --config "dab-config.MsSql.json" --relationship authors --relationship.fields "id:id" --target.entity Author_MM --cardinality many --linking.object book_author_link_mm --linking.source.fields "book_id" --linking.target.fields "author_id"
 update Review --config "dab-config.MsSql.json" --permissions "authenticated:create,read,update,delete"
 update Review --config "dab-config.MsSql.json" --relationship books --target.entity Book --cardinality one
+update Review --config "dab-config.MsSql.json" --relationship website_users --target.entity WebsiteUser --cardinality one --relationship.fields "websiteuser_id:id"
+update Review --config "dab-config.MsSql.json" --permissions "role_multiple_create_policy_tester:read" --policy-database "@item.websiteuser_id ne 1"
+update Review --config "dab-config.MsSql.json" --permissions "role_multiple_create_policy_tester:create" --policy-database "@item.content ne 'Great'"
+update Review --config "dab-config.MsSql.json" --permissions "role_multiple_create_policy_tester:update,delete"
+update Review_MM --config "dab-config.MsSql.json" --permissions "authenticated:*" --relationship books --relationship.fields "book_id:id" --target.entity Book_MM --cardinality one
+update Review_MM --config "dab-config.MsSql.json" --relationship website_users --target.entity WebsiteUser_MM --cardinality one --relationship.fields "websiteuser_id:id"
 update BookWebsitePlacement --config "dab-config.MsSql.json" --permissions "authenticated:create,update" --rest true --graphql true
 update BookWebsitePlacement --config "dab-config.MsSql.json" --permissions "authenticated:delete" --fields.include "*" --policy-database "@claims.userId eq @item.id"
 update Author --config "dab-config.MsSql.json"  --permissions "authenticated:create,read,update,delete" --rest true --graphql true
 update WebsiteUser --config "dab-config.MsSql.json" --permissions "authenticated:create,read,delete,update" --rest false --graphql "websiteUser:websiteUsers"
+update WebsiteUser -c "dab-config.MsSql.json" --relationship reviews --target.entity Review --cardinality many --relationship.fields "id:websiteuser_id"
+update WebsiteUser_MM --config "dab-config.MsSql.json" --source website_users_mm --permissions "authenticated:*" --relationship reviews --relationship.fields "id:websiteuser_id" --target.entity Review_MM --cardinality many
 update Revenue --config "dab-config.MsSql.json" --permissions "database_policy_tester:create" --policy-database "@item.revenue gt 1000"
 update Comic --config "dab-config.MsSql.json" --permissions "authenticated:create,read,update,delete" --rest true --graphql true --relationship myseries --target.entity series --cardinality one
 update series --config "dab-config.MsSql.json" --relationship comics --target.entity Comic --cardinality many
@@ -134,6 +157,7 @@ update books_view_with_mapping --config "dab-config.MsSql.json" --map "id:book_i
 update BookWebsitePlacement --config "dab-config.MsSql.json" --relationship books --target.entity Book --cardinality one
 update SupportedType --config "dab-config.MsSql.json" --map "id:typeid" --permissions "authenticated:create,read,delete,update" 
 update Author --config "dab-config.MsSql.json" --relationship books --target.entity Book --cardinality many --linking.object book_author_link
+update Author_MM --config "dab-config.MsSql.json"  --permissions "authenticated:*" --relationship books --relationship.fields "id:id" --target.entity Book_MM --cardinality many --linking.object book_author_link_mm --linking.source.fields "author_id" --linking.target.fields "book_id"
 update Notebook --config "dab-config.MsSql.json" --permissions "anonymous:create,update,delete"
 update Empty --config "dab-config.MsSql.json" --permissions "anonymous:read"
 update Journal --config "dab-config.MsSql.json" --permissions "policy_tester_noupdate:update" --fields.include "*" --policy-database "@item.id ne 1"

src/Config/DataApiBuilderException.cs

@@ -113,7 +113,11 @@ public enum SubStatusCodes
         /// <summary>
         /// Invalid PK field(s) specified in the request.
         /// </summary>
-        InvalidIdentifierField
+        InvalidIdentifierField,
+        /// <summary>
+        /// Relationship Field's value not found
+        /// </summary>
+        RelationshipFieldNotFound
     }
 
     public HttpStatusCode StatusCode { get; }

src/Core/Resolvers/BaseSqlQueryBuilder.cs

@@ -318,8 +318,16 @@ protected virtual string Build(Predicate? predicate)
         /// <summary>
         /// Build and join predicates with separator (" AND " by default)
         /// </summary>
-        protected string Build(List<Predicate> predicates, string separator = " AND ")
+        /// <param name="predicates">List of predicates to be added</param>
+        /// <param name="separator">Operator to be used with the list of predicates. Default value: AND</param>
+        /// <param name="isMultipleCreateOperation">Indicates whether the predicates are being formed for a multiple create operation. Default value: false.</param>
+        protected string Build(List<Predicate> predicates, string separator = " AND ", bool isMultipleCreateOperation = false)
         {
+            if (isMultipleCreateOperation)
+            {
+                return "(" + string.Join(separator, predicates.Select(p => Build(p))) + ")";
+            }
+
             return string.Join(separator, predicates.Select(p => Build(p)));
         }
 

src/Core/Resolvers/IQueryBuilder.cs

@@ -16,6 +16,7 @@ public interface IQueryBuilder
         /// query.
         /// </summary>
         public string Build(SqlQueryStructure structure);
+
         /// <summary>
         /// Builds the query specific to the target database for the given
         /// SqlInsertStructure object which holds the major components of the

src/Core/Resolvers/IQueryEngine.cs

@@ -22,6 +22,20 @@ public interface IQueryEngine
         /// </returns>
         public Task<Tuple<JsonDocument?, IMetadata?>> ExecuteAsync(IMiddlewareContext context, IDictionary<string, object?> parameters, string dataSourceName);
 
+        /// <summary>
+        /// Executes the given IMiddlewareContext of the GraphQL query and expects a list of JsonDocument objects back.
+        /// This method accepts a list of PKs for which to construct and return the response.
+        /// </summary>
+        /// <param name="context">IMiddleware context of the GraphQL query</param>
+        /// <param name="parameters">List of PKs for which the response Json have to be computed and returned.
+        /// Each Pk is represented by a dictionary where (key, value) as (column name, column value).
+        /// Primary keys can be of composite and be of any type. Hence, the decision to represent
+        /// a PK as Dictionary<string, object?>
+        /// </param>
+        /// <param name="dataSourceName">DataSource name</param>
+        /// <returns>Returns the json result and metadata object for the given list of PKs</returns>
+        public Task<Tuple<JsonDocument?, IMetadata?>> ExecuteMultipleCreateFollowUpQueryAsync(IMiddlewareContext context, List<IDictionary<string, object?>> parameters, string dataSourceName) => throw new NotImplementedException();
+
         /// <summary>
         /// Executes the given IMiddlewareContext of the GraphQL and expecting a
         /// list of Jsons back.

src/Core/Resolvers/IQueryExecutor.cs

@@ -34,6 +34,28 @@ public interface IQueryExecutor
             HttpContext? httpContext = null,
             List<string>? args = null);
 
+        /// <summary>
+        /// Executes sql text with the given parameters and
+        /// uses the function dataReaderHandler to process
+        /// the results from the DbDataReader and return into an object of type TResult.
+        /// This method is synchronous. It does not make use of async/await.
+        /// </summary>
+        /// <param name="sqltext">SQL text to be executed.</param>
+        /// <param name="parameters">The parameters used to execute the SQL text.</param>
+        /// <param name="dataReaderHandler">The function to invoke to handle the results
+        /// in the DbDataReader obtained after executing the query.</param>
+        /// <param name="httpContext">Current request httpContext.</param>
+        /// <param name="args">List of string arguments to the DbDataReader handler.</param>
+        /// <param name="dataSourceName">dataSourceName against which to run query. Can specify null or empty to run against default db.</param>
+        /// <returns>An object formed using the results of the query as returned by the given handler.</returns>
+        public TResult? ExecuteQuery<TResult>(
+            string sqltext,
+            IDictionary<string, DbConnectionParam> parameters,
+            Func<DbDataReader, List<string>?, TResult>? dataReaderHandler,
+            HttpContext? httpContext = null,
+            List<string>? args = null,
+            string dataSourceName = "");
+
         /// <summary>
         /// Extracts the rows from the given DbDataReader to populate
         /// the JsonArray to be returned.
@@ -63,10 +85,20 @@ public Task<JsonArray> GetJsonArrayAsync(
         /// <param name="dbDataReader">A DbDataReader</param>
         /// <param name="args">List of columns to extract. Extracts all if unspecified.</param>
         /// <returns>Current Result Set in the DbDataReader.</returns>
-        public Task<DbResultSet> ExtractResultSetFromDbDataReader(
+        public Task<DbResultSet> ExtractResultSetFromDbDataReaderAsync(
                 DbDataReader dbDataReader,
                 List<string>? args = null);
 
+        /// <summary>
+        /// Extracts the current Result Set of DbDataReader and format it
+        /// so it can be used as a parameter to query execution.
+        /// This method is synchronous. This does not make use of async await operations.
+        /// </summary>
+        /// <param name="dbDataReader">A DbDataReader</param>
+        /// <param name="args">List of columns to extract. Extracts all if unspecified.</param>
+        /// <returns>Current Result Set in the DbDataReader.</returns>
+        public DbResultSet ExtractResultSetFromDbDataReader(DbDataReader dbDataReader, List<string>? args = null);
+
         /// <summary>
         /// Extracts the result set corresponding to the operation (update/insert) being executed.
         /// For PgSql,MySql, returns the first result set (among the two for update/insert) having non-zero affected rows.
@@ -87,7 +119,18 @@ public Task<DbResultSet> GetMultipleResultSetsIfAnyAsync(
         /// <param name="dbDataReader">A DbDataReader.</param>
         /// <param name="args">List of string arguments if any.</param>
         /// <returns>A dictionary of properties of the DbDataReader like RecordsAffected, HasRows.</returns>
-        public Task<Dictionary<string, object>> GetResultProperties(
+        public Task<Dictionary<string, object>> GetResultPropertiesAsync(
+                DbDataReader dbDataReader,
+                List<string>? args = null);
+
+        /// <summary>
+        /// Gets the result properties like RecordsAffected, HasRows in a dictionary.
+        /// This is a synchronous method. It does not make use of async/await.
+        /// </summary>
+        /// <param name="dbDataReader">A DbDataReader.</param>
+        /// <param name="args">List of string arguments if any.</param>
+        /// <returns>A dictionary of properties of the DbDataReader like RecordsAffected, HasRows.</returns>
+        public Dictionary<string, object> GetResultProperties(
                 DbDataReader dbDataReader,
                 List<string>? args = null);
 
@@ -98,6 +141,14 @@ public Task<Dictionary<string, object>> GetResultProperties(
         /// </summary>
         public Task<bool> ReadAsync(DbDataReader reader);
 
+        /// <summary>
+        /// Wrapper for DbDataReader.Read().
+        /// This will catch certain db errors and throw an exception which can
+        /// be reported to the user.
+        /// This method is synchronous. It does not make use of async/await.
+        /// </summary>
+        public bool Read(DbDataReader reader);
+
         /// <summary>
         /// Modified the properties of the supplied connection to support managed identity access.
         /// </summary>

src/Core/Resolvers/MsSqlQueryBuilder.cs

@@ -42,11 +42,24 @@ public string Build(SqlQueryStructure structure)
                     structure.JoinQueries.Select(
                         x => $" OUTER APPLY ({Build(x.Value)}) AS {QuoteIdentifier(x.Key)}({dataIdent})"));
 
-            string predicates = JoinPredicateStrings(
+            string predicates;
+
+            if (structure.IsMultipleCreateOperation)
+            {
+                predicates = JoinPredicateStrings(
+                                    structure.GetDbPolicyForOperation(EntityActionOperation.Read),
+                                    structure.FilterPredicates,
+                                    Build(structure.Predicates, " OR ", isMultipleCreateOperation: true),
+                                    Build(structure.PaginationMetadata.PaginationPredicate));
+            }
+            else
+            {
+                predicates = JoinPredicateStrings(
                                     structure.GetDbPolicyForOperation(EntityActionOperation.Read),
                                     structure.FilterPredicates,
                                     Build(structure.Predicates),
                                     Build(structure.PaginationMetadata.PaginationPredicate));
+            }
 
             string query = $"SELECT TOP {structure.Limit()} {WrappedColumns(structure)}"
                 + $" FROM {fromSql}"

src/Core/Resolvers/MsSqlQueryExecutor.cs

@@ -231,7 +231,7 @@ public override async Task<DbResultSet> GetMultipleResultSetsIfAnyAsync(
             DbDataReader dbDataReader, List<string>? args = null)
         {
             // From the first result set, we get the count(0/1) of records with given PK.
-            DbResultSet resultSetWithCountOfRowsWithGivenPk = await ExtractResultSetFromDbDataReader(dbDataReader);
+            DbResultSet resultSetWithCountOfRowsWithGivenPk = await ExtractResultSetFromDbDataReaderAsync(dbDataReader);
             DbResultSetRow? resultSetRowWithCountOfRowsWithGivenPk = resultSetWithCountOfRowsWithGivenPk.Rows.FirstOrDefault();
             int numOfRecordsWithGivenPK;
 
@@ -249,7 +249,7 @@ public override async Task<DbResultSet> GetMultipleResultSetsIfAnyAsync(
             }
 
             // The second result set holds the records returned as a result of the executed update/insert operation.
-            DbResultSet? dbResultSet = await dbDataReader.NextResultAsync() ? await ExtractResultSetFromDbDataReader(dbDataReader) : null;
+            DbResultSet? dbResultSet = await dbDataReader.NextResultAsync() ? await ExtractResultSetFromDbDataReaderAsync(dbDataReader) : null;
 
             if (dbResultSet is null)
             {