Db2Code–part 2- architecture
What we will build you can see here :
Each class will have it is own CodeTemplates\EFCore templates from which will generate the code.
Let’s start with ExampleModels : Here will be the class definitions . From the table defintion , the DB2Code will generate
1. A definition of a interface with table columns as properties
1 2 3 4 5 | public interface I_Department_Table { long IDDepartment { get; set; } string Name { get; set; }} |
2. A class with relationships
01 02 03 04 05 06 07 08 09 10 11 12 | public partial class Department{ [Key] public long IDDepartment { get; set; } [StringLength(50)] [Unicode(false)] public string Name { get; set; } = null!; [InverseProperty("IDDepartmentNavigation")] public virtual ICollection<Employee> Employee { get; } = new List<Employee>();} |
3. class without relationship
1 2 3 4 5 | public class Department_Table : I_Department_Table{ public long IDDepartment { get; set; } public string Name { get; set; } } |
4. Explicit operator to convert 2 to 3
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 | public static explicit operator Department_Table?(Department obj) { if(obj == null)return null;//System.Diagnostics.Debugger.Break();var ret= new Department_Table();ret.CopyFrom(obj as I_Department_Table );return ret;}public static explicit operator Department?(Department_Table obj) { if(obj == null)return null;//System.Diagnostics.Debugger.Break();var ret= new Department();ret.CopyFrom(obj as I_Department_Table) ;return ret;} |
5. Public method CopyFrom( interface)
1 2 3 4 | public void CopyFrom(I_Department_Table other) { this.IDDepartment = other.IDDepartment; this.Name = other.Name;} |
5. Enum with name of the columns
1 2 3 4 5 | public enum eDepartmentColumns {None = 0,IDDepartment ,Name } |
6. Metadata with name of the tables and the columns
1 2 3 4 5 6 7 8 | public static MetaTable metaData = new("Department");static Department_Table (){ MetaColumn mc=null; mc=new ("IDDepartment","long",false); metaData.AddColumn(mc); mc=new ("Name","string",false); metaData.AddColumn(mc);} |
Now it comes ExampleContext . Here will the database context and various search definitions that you need (e.g. for a column of type int, search will generate = , > , < , between , in array ) . More , it will generate metadata for the tables that are part of the context.
1 2 3 4 | public IAsyncEnumerable<Department> DepartmentSimpleSearch(GeneratorFromDB.SearchCriteria sc, eDepartmentColumns colToSearch, string value){}public IAsyncEnumerable<Department> DepartmentGetAll(){}public async Task<Department[]> DepartmentFind_Array( SearchDepartment? search){}public Task<long> DepartmentCount( SearchDepartment search) |
Now it comes ExampleControllers . This will generate controllers for REST API for the table and also Search Controllers for any kind of search that you may want.
001 002 003 004 005 006 007 008 009 010 011 012 013 014 015 016 017 018 019 020 021 022 023 024 025 026 027 028 029 030 031 032 033 034 035 036 037 038 039 040 041 042 043 044 045 046 047 048 049 050 051 052 053 054 055 056 057 058 059 060 061 062 063 064 065 066 067 068 069 070 071 072 073 074 075 076 077 078 079 080 081 082 083 084 085 086 087 088 089 090 091 092 093 094 095 096 097 098 099 100 101 102 | //this is the REST controller[ApiController][Route("[controller]")] public partial class RESTDepartmentController : Controller{ private ApplicationDBContext _context; public RESTDepartmentController(ApplicationDBContext context) { _context=context; } [HttpGet] public async Task<Department_Table[]> Get(){ var data= await _context.Department.ToArrayAsync(); var ret = data.Select(it => (Department_Table)it!).ToArray(); return ret; } [HttpGet("{id}")] public async Task<ActionResult<Department_Table>> GetDepartment(long id) { if (_context.Department == null) { return NotFound(); } var item = await _context.Department.FirstOrDefaultAsync(e => e.IDDepartment==id); if (item == null) { return NotFound(); } return (Department_Table)item!; } [HttpPatch("{id}")] public async Task<IActionResult> PutDepartment(long id, Department value) { if (id != value.IDDepartment) { return BadRequest(); } _context.Entry(value).State = EntityState.Modified; try { await _context.SaveChangesAsync(); } catch (DbUpdateConcurrencyException) { if (!DepartmentExists(id)) { return NotFound(); } else { throw; } } return NoContent(); } [HttpPost] public async Task<ActionResult<Department>> PostDepartment(Department_Table value) { var val = new Department(); val.CopyFrom(value); _context.Department.Add(val); await _context.SaveChangesAsync(); return CreatedAtAction("GetDepartment", new { id = val.IDDepartment }, val); } [HttpDelete("{id}")] public async Task<IActionResult> DeleteDepartment(long id) { if (_context.Department == null) { return NotFound(); } var item = await _context.Department.FirstOrDefaultAsync(e => e.IDDepartment==id); if (item == null) { return NotFound(); } _context.Department .Remove(item); await _context.SaveChangesAsync(); return NoContent(); } private bool DepartmentExists(long id) { return (_context.Department.Any(e => e.IDDepartment == id)); } } |
And also a SEARCH controller
001 002 003 004 005 006 007 008 009 010 011 012 013 014 015 016 017 018 019 020 021 022 023 024 025 026 027 028 029 030 031 032 033 034 035 036 037 038 039 040 041 042 043 044 045 046 047 048 049 050 051 052 053 054 055 056 057 058 059 060 061 062 063 064 065 066 067 068 069 070 071 072 073 074 075 076 077 078 079 080 081 082 083 084 085 086 087 088 089 090 091 092 093 094 095 096 097 098 099 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 | [ApiController][Route("[controller]/[action]")] public partial class AdvancedSearchDepartmentController : Controller{ private ISearchDataDepartment _search; public AdvancedSearchDepartmentController(ISearchDataDepartment search) { _search=search; } [HttpGet] public async IAsyncEnumerable<Department_Table> GetAll() { await foreach(var item in _search.DepartmentFind_AsyncEnumerable(null)) { yield return (Department_Table)item!; } } [HttpGet] public async IAsyncEnumerable<Department_Table> GetWithSearch(SearchDepartment s) { await foreach(var item in _search.DepartmentFind_AsyncEnumerable(s)) { yield return (Department_Table)item!; } }//has one key [HttpGet] public async Task<Department_Table?> GetSingle(long id){ var data=await _search.DepartmentGetSingle(id); if(data == null) return null; return (Department_Table)data; } [HttpGet] public async IAsyncEnumerable<Department_Table> EqualValues_IDDepartment( long[] values) { string? value=null; if(values.Length>0) value=string.Join( ",",values); var sc=SearchDepartment.FromSearch(GeneratorFromDB.SearchCriteria.InArray,eDepartmentColumns.IDDepartment,value); await foreach (var item in _search.DepartmentFind_AsyncEnumerable(sc)) { yield return (Department_Table)item!; } } [HttpGet] public async IAsyncEnumerable<Department_Table> DifferentValues_IDDepartment( long[] values) { string? value=null; if(values.Length>0) value=string.Join( ",",values); var sc=SearchDepartment.FromSearch(GeneratorFromDB.SearchCriteria.NotInArray,eDepartmentColumns.IDDepartment,value); await foreach (var item in _search.DepartmentFind_AsyncEnumerable(sc)) { yield return (Department_Table)item!; } } [HttpGet] public async IAsyncEnumerable<Department_Table> EqualValue_IDDepartment( long value) { var sc = GeneratorFromDB.SearchCriteria.Equal; await foreach (var item in _search.DepartmentSimpleSearch_IDDepartment(sc, value)) { yield return (Department_Table)item!; } } [HttpGet] public async IAsyncEnumerable<Department_Table> DifferentValue_IDDepartment( long value) { var sc = GeneratorFromDB.SearchCriteria.Different; await foreach (var item in _search.DepartmentSimpleSearch_IDDepartment(sc, value)) { yield return (Department_Table)item!; } } [HttpGet] public async IAsyncEnumerable<Department_Table> SimpleSearch_IDDepartment(GeneratorFromDB.SearchCriteria sc, long value){ await foreach(var item in _search.DepartmentSimpleSearch_IDDepartment(sc,value)) { yield return (Department_Table)item!; } } [HttpGet] public async IAsyncEnumerable<Department_Table> FindNull_IDDepartment(){ var sc = GeneratorFromDB.SearchCriteria.Equal; await foreach(var item in _search.DepartmentSimpleSearchNull_IDDepartment(sc)) { yield return (Department_Table)item!; } } [HttpGet] public async IAsyncEnumerable<Department_Table> FindNotNull_IDDepartment(){ var sc = GeneratorFromDB.SearchCriteria.Different; await foreach(var item in _search.DepartmentSimpleSearchNull_IDDepartment(sc)) { yield return (Department_Table)item!; } } [HttpGet] public async IAsyncEnumerable<Department_Table> EqualValues_Name( string[] values) { string? value=null; if(values.Length>0) value=string.Join( ",",values); var sc=SearchDepartment.FromSearch(GeneratorFromDB.SearchCriteria.InArray,eDepartmentColumns.Name,value); await foreach (var item in _search.DepartmentFind_AsyncEnumerable(sc)) { yield return (Department_Table)item!; } } [HttpGet] public async IAsyncEnumerable<Department_Table> DifferentValues_Name( string[] values) { string? value=null; if(values.Length>0) value=string.Join( ",",values); var sc=SearchDepartment.FromSearch(GeneratorFromDB.SearchCriteria.NotInArray,eDepartmentColumns.Name,value); await foreach (var item in _search.DepartmentFind_AsyncEnumerable(sc)) { yield return (Department_Table)item!; } } [HttpGet] public async IAsyncEnumerable<Department_Table> EqualValue_Name( string value) { var sc = GeneratorFromDB.SearchCriteria.Equal; await foreach (var item in _search.DepartmentSimpleSearch_Name(sc, value)) { yield return (Department_Table)item!; } } [HttpGet] public async IAsyncEnumerable<Department_Table> DifferentValue_Name( string value) { var sc = GeneratorFromDB.SearchCriteria.Different; await foreach (var item in _search.DepartmentSimpleSearch_Name(sc, value)) { yield return (Department_Table)item!; } } [HttpGet] public async IAsyncEnumerable<Department_Table> SimpleSearch_Name(GeneratorFromDB.SearchCriteria sc, string value){ await foreach(var item in _search.DepartmentSimpleSearch_Name(sc,value)) { yield return (Department_Table)item!; } } [HttpGet] public async IAsyncEnumerable<Department_Table> FindNull_Name(){ var sc = GeneratorFromDB.SearchCriteria.Equal; await foreach(var item in _search.DepartmentSimpleSearchNull_Name(sc)) { yield return (Department_Table)item!; } } [HttpGet] public async IAsyncEnumerable<Department_Table> FindNotNull_Name(){ var sc = GeneratorFromDB.SearchCriteria.Different; await foreach(var item in _search.DepartmentSimpleSearchNull_Name(sc)) { yield return (Department_Table)item!; } } }//end class |
Finally , ExampleWebAPI . This will add the controllers from the ExampleControllers to show the use .
1 2 3 4 | var assControllers = typeof(UtilsControllers).Assembly;builder.Services.AddControllers() .PartManager.ApplicationParts.Add(new AssemblyPart(assControllers)); ; |
Of course , the name Example will be replaced , from the template, with the name of your project
Leave a Reply