New or Changed APIs in 2019 R3

In 2019 R3 beta, a number of APIs have been added or changed for SnapObjects and .NET DataStore.

SnapObjects

Supports dynamic query with SqlModelMapper

The following interfaces are added to support dynamic query with SqlModelMapper class:

  • GetQueryBuilder<TModel> interface for returning QueryBuilder of models.

  • IQueryBuilder<TModel> interface for building query conditions.

Supports ASE database

The following classes are added to support the ASE database:

  • OdbcAseDataContext class
  • OdbcAseDataContextOptions class
  • OdbcAseDataContextOptions<TAdoDbContext> class
  • OdbcAseExtensions class

Supports cloud database on Amazon RDS

The following classes have been enhanced to support the cloud database on Amazon RDS:

  • SnapObjects.Data.MySql (for Aurora and MySQL)
  • SnapObjects.Data.PostgreSql (for Aurora and PostgreSQL)
  • SnapObjects.Data.Oracle (for Oracle)
  • SnapObjects.Data.SqlServer (for SQL Server)

New asynchronous methods for SqlExecutor

The following asynchronous methods are added to the SqlExecutor interface:

  1. Task<TValue> ScalarAsync<TValue>( sqlText, params object[] parameters);
  2. Task<TValue> ScalarAsync<TValue>( sqlText, CancellationToken cancellationToken);
  3. Task<TValue> ScalarAsync<TValue>(string sqlText, object[] parameters, CancellationToken cancellationToken);
  4. Task<TValue> ScalarAsync<TValue>(ISqlQueryBuilder sqlQueryBuilder, params object[] parameters);
  5. Task<TValue> ScalarAsync<TValue>(ISqlQueryBuilder sqlQueryBuilder, CancellationToken cancellationToken);
  6. Task<TValue> ScalarAsync<TValue>(ISqlQueryBuilder sqlQueryBuilder, object[] parameters, CancellationToken cancellationToken);
  7. Task<IList<TModel>> SelectAsync<TModel>(string sqlText, params object[] parameters);
  8. Task<IList<TModel>> SelectAsync<TModel>(string sqlText, CancellationTokencan cellationToken);
  9. Task<IList<TModel>> SelectAsync<TModel>(string sqlText, object[] parameters, CancellationToken cancellationToken);
  10. Task<IList<TModel>> SelectAsync<TModel>(ISqlQueryBuilder queryBuilder, params object[] parameters);
  11. Task<IList<TModel>> SelectAsync<TModel>(ISqlQueryBuilder queryBuilder, CancellationToken cancellationToken);
  12. Task<IList<TModel>> SelectAsync<TModel>(ISqlQueryBuilder queryBuilder, object[] parameters, CancellationToken cancellationToken);
  13. Task<TModel> SelectOneAsync<TModel>(string sqlText, params object[] parameters);
  14. Task<TModel> SelectOneAsync<TModel>(string sqlText, CancellationToken cancellationToken);
  15. Task<TModel> SelectOneAsync<TModel>(string sqlText, object[] parameters, CancellationToken cancellationToken);
  16. Task<TModel> SelectOneAsync<TModel>(ISqlQueryBuilder queryBuilder, params object[] parameters);
  17. Task<TModel> SelectOneAsync<TModel>(ISqlQueryBuilder queryBuilder, CancellationToken cancellationToken);
  18. Task<TModel> SelectOneAsync<TModel>(ISqlQueryBuilder queryBuilder, object[] parameters, CancellationToken cancellationToken);
  19. Task<int> ExecuteAsync(string sqlText, params object[] parameters);
  20. Task<int> ExecuteAsync(string sqlText, CancellationToken cancellationToken);
  21. Task<int> ExecuteAsync(string sqlText, object[] parameters, CancellationToken cancellationToken);
  22. Task<int> ExecuteProcedureAsync(string sqlText, params object[] parameters);
  23. Task<int> ExecuteProcedureAsync(string sqlText, CancellationToken cancellationToken);
  24. Task<int> ExecuteProcedureAsync(string sqlText, object[] parameters, CancellationToken cancellationToken);
  25. Task<IList<TModel>> SelectProcedureAsync<TModel>(string sqlText, params object[] parameters);
  26. Task<IList<TModel>> SelectProcedureAsync<TModel>(string sqlText, CancellationToken cancellationToken);
  27. Task<IList<TModel>> SelectProcedureAsync<TModel>(string sqlText, object[] parameters, CancellationToken cancellationToken);

The following asynchronous methods are added to support SelectLazy (in cases of using .NET Core 2.1)

  1. IAsyncEnumerable<TModel> SelectLazyAsync<TModel>(params object[] parameters);
  2. IAsyncEnumerable<TModel> SelectLazyAsync<TModel>(CancellationToken cancellationToken);
  3. IAsyncEnumerable<TModel> SelectLazyAsync<TModel>(object[] parameters, CancellationToken cancellationToken);
  4. IAsyncEnumerable<TModel> SelectLazyAsync<TModel>(ISqlQueryBuilder queryBuilder, params object[] parameters);
  5. IAsyncEnumerable<TModel> SelectLazyAsync<TModel>(ISqlQueryBuilder queryBuilder, CancellationToken cancellationToken);
  6. IAsyncEnumerable<TModel> SelectLazyAsync<TModel>(ISqlQueryBuilder queryBuilder, object[] parameters, CancellationToken cancellationToken);
  7. IAsyncEnumerable<TModel> SelectLazyAsync<TModel>(string sqlText, params object[] parameters);
  8. IAsyncEnumerable<TModel> SelectLazyAsync<TModel>(string sqlText, CancellationToken cancellationToken);
  9. IAsyncEnumerable<TModel> SelectLazyAsync<TModel>(string sqlText, object[] parameters, CancellationToken cancellationToken);

New asynchronous methods for SqlModelMapper

The following asynchronous methods are added to the SqlModelMapper interface:

  1. Task<ILoadable<TModel>> LoadAsync<TModel>(params object[] parameters);
  2. Task<ILoadable<TModel>> LoadAsync<TModel>(CancellationToken cancellationToken);
  3. Task<ILoadable<TModel>> LoadAsync<TModel>(object[] parameters, CancellationToken cancellationToken);
  4. Task<ILoadable<TModel>> LoadByPageAsync<TModel>(int currentIndex, int pageSize, params object[] parameters);
  5. Task<ILoadable<TModel>> LoadByPageAsync<TModel>(int currentIndex, int pageSize, CancellationToken cancellationToken);
  6. Task<ILoadable<TModel>> LoadByPageAsync<TModel>(int currentIndex, int pageSize, object[] parameters, CancellationToken cancellationToken);
  7. Task<ILoadable<TModel>> LoadAllAsync<TModel>();
  8. Task<ILoadable<TModel>> LoadAllAsync<TModel>(CancellationToken cancellationToken);
  9. Task<ILoadable<TModel>> LoadAllByPageAsync<TModel>(int currentIndex, int pageSize);
  10. Task<ILoadable<TModel>> LoadAllByPageAsync<TModel>(int currentIndex, int pageSize, CancellationToken cancellationToken);
  11. Task<ILoadable<TModel>> LoadByKeyAsync<TModel>(params object[] parameters);
  12. Task<ILoadable<TModel>> LoadByKeyAsync<TModel>(object[] parameters, CancellationToken cancellationToken);
  13. Task<TValue> ScalarAsync<TModel, TValue>(string expression, params object[] parameters);
  14. Task<TValue> ScalarAsync<TModel, TValue>(string expression, CancellationToken cancellationToken);
  15. Task<TValue> ScalarAsync<TModel, TValue>(string expression, object[] parameters, CancellationToken cancellationToken);
  16. Task<TValue> ScalarByKeyAsync<TModel, TValue>(string expression, params object[] parameters);
  17. Task<TValue> ScalarByKeyAsync<TModel, TValue>(string expression, object[] parameters, CancellationToken cancellationToken);
  18. Task<IDbResult> SaveChangesAsync();
  19. Task<IDbResult> SaveChangesAsync(CancellationToken cancellationToken);

.NET DataStore

New asynchronous methods for DataStore

The following asynchronous methods are added to the DataStore interface:

  1. Task<int> UpdateAsync(bool resetFlag = true);
  2. Task<int> UpdateAsync(CancellationToken cancellationToken);
  3. Task<int> UpdateAsync(bool resetFlag, CancellationToken cancellationToken);
  4. Task<int> UpdateAsync(UpdateSqlStrategy updateSqlStrategy, bool resetFlag = true);
  5. Task<int> UpdateAsync(UpdateSqlStrategy updateSqlStrategy, CancellationToken cancellationToken);
  6. Task<int> UpdateAsync(UpdateSqlStrategy updateSqlStrategy, bool resetFlag, CancellationToken cancellationToken);
  7. Task<int> ReselectRowAsync(int row);
  8. Task<int> ReselectRowAsync(int row, CancellationToken cancellationToken);
  9. Task<int> RetrieveAsync(CancellationToken cancellationToken);
  10. Task<int> RetrieveAsync(params object[] arguments);
  11. Task<int> RetrieveAsync(object[] arguments, CancellationToken cancellationToken);
  12. Task<int> RetrieveByKeyAsync(params object[] parameters);
  13. Task<int> RetrieveByKeyAsync(object[] parameters, CancellationToken cancellationToken);
  14. Task<int> RetrieveByPageAsync(int currentIndex, int pageSize, params object[] arguments);
  15. Task<int> RetrieveByPageAsync(int currentIndex, int pageSize, CancellationToken cancellationToken);
  16. Task<int> RetrieveByPageAsync(int currentIndex, int pageSize, object[] arguments, CancellationToken cancellationToken);

New class for importing template

The following class is added to support importing templates (in XML/JSON format, and of Grid/Group datatype).

  • DwTemplateImporter class

Supports TableBlob/InkPicture

The following attributes and datatype are added to support data retrieval and update with TableBlob/InkPicture:

  • DwTableBlobAttribute attribute for specifying the BLOB column.
  • DwInkPictureAttribute attribute for specifying the InkPic column.
  • InkPicture datatype for mapping with PowerBuilder InkPicture data.
    • Data property, corresponding to Data property in the PowerBuilder InkPicture column.
    • BackImage property, corresponding to BackImage property in the PowerBuilder InkPicture column.