🖊️ 😂 👨‍👩‍👦 .NET अनुप्रयोगों (कोर) में सीडिंग डेटाबेस के लिए DbTool का उपयोग करना 🌠 🛣️ 👏🏿

हम आपका ध्यान DbTool, विभिन्न स्वरूपों के लिए डेटाबेस डेटा निर्यात करने के लिए एक कमांड-लाइन उपयोगिता और Korzh.DbUtils ओपन-सोर्स लाइब्रेरी में प्रस्तुत करते हैं, जिसके उपयोग से आपके .NET (कोर) एप्लिकेशन में डेटाबेस की प्रारंभिक "बुवाई" को बहुत सरल किया जा सकता है।

इस टूलकिट के साथ, आप यह कर सकते हैं:

अपने स्थानीय डेटाबेस से डेटा को एक निश्चित पाठ प्रारूप (XML, JSON) की फ़ाइलों में सहेजें, जो प्रोजेक्ट से कनेक्ट करना आसान है।
सहेजे गए फ़ाइलों का उपयोग एप्लिकेशन के डेटाबेस को अपनी पहली शुरुआत में पॉप्युलेट करने के लिए करें।

नीचे मैं आपको बताऊंगा कि यह सब क्यों आवश्यक है, इन उपकरणों को कैसे स्थापित करें और कॉन्फ़िगर करें और उनके उपयोग के लिए एक विस्तृत परिदृश्य का वर्णन करें।

हमने DbTool क्यों किया

प्रारंभिक कार्य .NET (कोर) अनुप्रयोगों में एक सुविधाजनक डेटाबेस फिलिंग तंत्र बनाना था। हमारे प्रकार की गतिविधि (घटक विकास) की बारीकियों के कारण, हमें अक्सर छोटे नमूना अनुप्रयोग बनाने पड़ते हैं जो हमारे उत्पाद की एक या दूसरी विशेषता को प्रदर्शित करते हैं। ऐसी डेमो परियोजनाओं को एक निश्चित परीक्षण डेटाबेस के साथ काम करना चाहिए और इसलिए आवेदन की पहली शुरुआत में इस डेटाबेस को स्वचालित रूप से बनाना और आबाद करना उचित है।

यदि परियोजना इकाई फ्रेमवर्क (कोर) का उपयोग करती है (और यह सबसे अधिक बार होता है), तो डेटाबेस बनाने में कोई समस्या नहीं है। आप बस dbContext.Database.EnsureCreated या dbContext.Database.Migrate (यदि यह माइग्रेशन रखना महत्वपूर्ण है) को कॉल करें।

लेकिन डेटाबेस भरने के साथ, सब कुछ थोड़ा अधिक जटिल है। पहली बात जो दिमाग में आती है वह है INSERTs के एक समूह के साथ एक SQL स्क्रिप्ट बनाने के लिए, इसे प्रोजेक्ट में रखें और इसे पहली शुरुआत में निष्पादित करें। यह काम करता है (और हमने लंबे समय तक किया था), लेकिन इस दृष्टिकोण के साथ कुछ समस्याएं हैं। सबसे पहले, एक विशिष्ट DBMS के लिए एक SQL सिंटैक्स समस्या। अक्सर, मूल DBMS उस से भिन्न होता है जो वास्तव में उपयोगकर्ता द्वारा उपयोग किया जाता है और हमारी SQL स्क्रिप्ट काम नहीं कर सकती है।

दूसरी संभावित समस्या डेटाबेस का माइग्रेशन है। समय-समय पर, डेटाबेस संरचना को थोड़ा बदलने की जरूरत है (एक नया क्षेत्र जोड़ें, पुराने को हटाएं या नाम बदलें, तालिकाओं, आदि के बीच एक नया संबंध जोड़ें)। पुरानी संरचना के तहत बनाई गई SQL स्क्रिप्ट आमतौर पर इस मामले में अप्रासंगिक हो जाती है और इसके निष्पादन में त्रुटि होती है। जबकि कुछ तृतीय-पक्ष प्रारूप से डेटा लोड करना समस्याओं के बिना जाता है। नए / परिवर्तित फ़ील्ड को बस छोड़ दिया जाता है। इस बात से सहमत हैं कि प्रदर्शन के प्रयोजनों के लिए यह बेहतर है कि कार्यक्रम शुरू हो, कुछ नए क्षेत्र में डेटा के बिना, इस से यह बिल्कुल भी शुरू नहीं होता है।

परिणामस्वरूप, हम निम्नलिखित समाधान पर आए:

हमारे डेमो डेटाबेस की "मास्टर कॉपी" का डेटा एक निश्चित "स्वतंत्र" प्रारूप में एक फ़ाइल में दर्ज किया गया है (वर्तमान में यह एक्सएमएल या डॉसन है)। परिणामी फाइलें (या एक संग्रह फ़ाइल) परियोजना के साथ वितरित की जाती हैं। यह कार्य, वास्तव में, DbTool से संबंधित है।
कोड का एक छोटा सा टुकड़ा हमारे प्रोग्राम में डाला जाता है, जो पहले चरण में प्राप्त फ़ाइल (एस) से डेटा के साथ डेटाबेस को भरता है।
उपरोक्त परिदृश्य के अलावा, DbTool का उपयोग केवल डेटा को अन्य प्रारूपों में निर्यात करने और डेटाबेस के बीच डेटा स्थानांतरित करने के लिए किया जा सकता है। इसलिए, उदाहरण के लिए, आप अपने डेटाबेस से SQL सर्वर पर डेटा अपलोड कर सकते हैं और फिर इसे MySQL में एक समान डेटाबेस में लोड कर सकते हैं

स्थापना

DbTool को .NET कोर ग्लोबल टूल के रूप में लागू किया गया है अर्थात् किसी भी सिस्टम पर आसानी से स्थापित किया जा सकता है जहाँ .NET SDK संस्करण 2.1 या उच्चतर है।

उपयोगिता को स्थापित करने के लिए, आपको केवल कंसोल (टर्मिनल / कमांड प्रॉम्प्ट) खोलने और निम्नलिखित कमांड चलाने की आवश्यकता है:

 dotnet tool install -g Korzh.DbTool

स्थापना के बाद dbtool के लिए, कंसोल में dbtool टाइप करें और आप उपलब्ध कमांड की सूची के साथ मदद देखेंगे।

डेटाबेस से कनेक्शन जोड़ें

DbTool के साथ काम करना शुरू करने के लिए आपको एक डेटाबेस कनेक्शन जोड़ना होगा:

 dbtool add {YourConnectionId} {DbType} {YourConnectionString}

यहां:

{YourConnectionId} एक पहचानकर्ता है जिसे आप इस कनेक्शन को असाइन करना चाहते हैं ताकि आप इसे बाद में एक्सेस कर सकें जब आप अन्य कमांड चलाते हैं।
DbType आपके DBMS का प्रकार है। इस लेखन के समय, DbTool (संस्करण 1.1.7) ने SQL सर्वर (mssql) और MySQL (mysql) डेटाबेस का समर्थन किया।
इस कमांड में अंतिम पैरामीटर कनेक्शन स्ट्रिंग है। वही जो आप पहले से ही अपने .NET (कोर) प्रोजेक्ट में उपयोग करते हैं।

एक उदाहरण:

उसके बाद, आप टाइप करके अपने सभी कनेक्शनों की जाँच कर सकते हैं:

 dbtool connections list

डेटा निर्यात

अब हमने कनेक्शन जोड़ दिया है, हम निर्यात कमांड का उपयोग करके अपने डेटाबेस को निर्यात कर सकते हैं:

 dbtool export {ConnectionId} [--format=xml|json] [--output={path-to-folder}] [--zip={file-name}]

ऊपर उल्लिखित कोई भी विकल्प छोड़ा जा सकता है। यदि आप format निर्दिष्ट नहीं करते हैं format तो JSON का उपयोग किया जाएगा। यदि आप output विकल्प को छोड़ देते हैं, तो परिणाम को किसी अनपैक्ड रूप में ConnectionId_yyyy-MM-dd फॉर्म की एक निर्देशिका में रखा जाएगा।

उदाहरण के लिए, निम्न आदेश:

 dbtool export MyDb01 --zip=MyDbData.zip

वर्तमान निर्देशिका में MyDbData.zip नाम के साथ एक ज़िप संग्रह तैयार करेगा और इसे JSON प्रारूप (प्रत्येक डेटाबेस तालिका के लिए एक फ़ाइल) में डेटा फ़ाइलों के साथ भर देगा।

डेटा आयात

आप पिछले चरण में बनाए गए डेटा को अपने डेटाबेस में वापस आयात कर सकते हैं। या समान संरचना वाले किसी अन्य आधार पर।

महत्वपूर्ण: DbTool आयात ऑपरेशन के दौरान तालिकाओं का निर्माण नहीं करता है। इस प्रकार, जिस डेटाबेस में डेटा आयात किया जाता है, वह पहले से मौजूद होना चाहिए और मूल (जैसे कम से कम समान) संरचना होना चाहिए।

आयात आदेश स्वयं इस प्रकार है:

 dbtool import {ConnectionId} [--input=path-to-file-or-folder] [--format=xml|json]

--input विकल्प उपयोगिता को बताता है कि आयातित डेटा कहां देखना है। यदि कोई फ़ोल्डर पथ निर्दिष्ट है, तो DbTool इस फ़ोल्डर में .xml या .json फ़ाइलें आयात करेगा। यदि यह एक ज़िप फ़ाइल है, तो उपयोगिता पहले इस संग्रह को अनज़िप करेगी और वहाँ से आवश्यक डेटा फ़ाइलों को हटा देगी।

जैसा कि पिछले मामले में, --फॉर्मट को छोड़ा जा सकता है क्योंकि DbTool फ़ाइल एक्सटेंशन द्वारा प्रारूप को पहचान सकता है।

एक उदाहरण:

 dbtool import MyDb01 --input=MyDbData.zip

पुस्तकालय Korzh.DbUtils

DbTool उपयोगिता स्वयं ओपन-सोर्स लाइब्रेरी Korzh.DbUtils के आधार पर बनाई गई है, जिसमें कुछ बुनियादी डेटाबेस संचालन के कार्यान्वयन के साथ कई पैकेज शामिल हैं।

Korzh.DbUtils

IDatasetExporter, IDatasetImporter, IDataPacker, IDbBridge जैसे बुनियादी सार और इंटरफेस को परिभाषित करता है

Korzh.DbUtils.Import

XML और JSON प्रारूपों के लिए IDatasetImporter इंटरफेस के कार्यान्वयन शामिल हैं। इसके अलावा, इस पैकेज में DbInitializer वर्ग शामिल है, जिसका उपयोग आप अपनी परियोजनाओं में डेटा को पॉप्युलेट करने के लिए कर सकते हैं।

Korzh.DbUtils.Export

XML और JSON के लिए IDatasetExporter के कार्यान्वयन शामिल हैं।

Korzh.DbUtils.SqlServer

MS SQL सर्वर के लिए बुनियादी डेटाबेस ऑपरेशन (IDbBridge, IDbReader, IDbSeeder) के इंटरफेस के कार्यान्वयन को शामिल करता है।

Korzh.DbUtils.MySQL

MySQL के लिए डेटाबेस इंटरफेस के कार्यान्वयन में शामिल है।

यहाँ आप Korzh.DbUtils लाइब्रेरी एपीआई पर पूरा संदर्भ पा सकते हैं।

अनुप्रयोग स्टार्टअप पर डेटा के साथ डेटाबेस को आबाद करने के लिए Korzh.DbUtils का उपयोग करना

अब, वास्तव में, हम इस बात पर विचार करेंगे कि एप्लिकेशन के पहले लॉन्च में डेटाबेस को भरने (सीडिंग) के लिए मूल स्क्रिप्ट को लागू करने के लिए डीबीटूल और कोरज़डब्यूटिल्स का उपयोग कैसे करें।

मान लें कि आपके पास कुछ डेटाबेस का "मास्टर कॉपी" है जिसे आपको एप्लिकेशन शुरू करने पर उपयोगकर्ता के कंप्यूटर पर "कॉपी" करने की आवश्यकता है।

चरण 1: JSON में मास्टर कॉपी निर्यात करें

बस DbTool स्थापित करें, जैसा कि ऊपर वर्णित है, डेटाबेस से एक कनेक्शन जोड़ें और इस डेटाबेस से सभी डेटा को एक अलग फ़ोल्डर में सहेजने के लिए निर्यात कमांड चलाएं:

 dotnet tool install -g Korzh.DbTool dbtool connections add MyMasterDb mssql "{ConnectionString}" dbtool export MyMasterDb

चरण 2: हमारी परियोजना में डेटा फ़ाइलें जोड़ें

पिछले चरण के बाद, हमारे पास फॉर्म का एक नया फ़ोल्डर है, फॉर्म MyMasterDb-yyyy-MM-dd, जिसमें JSON फ़ाइलों का एक गुच्छा (प्रत्येक तालिका के लिए एक) है। बस इस फ़ोल्डर की सामग्री को हमारे .NET (कोर) परियोजना के App_Data \ DbSeed में कॉपी करें। कृपया ध्यान दें कि .NET फ्रेमवर्क के तहत परियोजनाओं के लिए आपको इन फ़ाइलों को प्रोजेक्ट में मैन्युअल रूप से जोड़ना होगा।

चरण 3: डीबी आरंभीकरण कोड

हालाँकि प्रक्रिया स्वयं (कुछ विवरण तक) .NET कोर या .NET फ्रेमवर्क (संस्करण 4.6.1 या उच्चतर) के तहत किसी भी प्रकार की परियोजना के लिए लागू होती है, विवरण की सादगी के लिए, मान लें कि हम एक ASP.NET कोर परियोजना के बारे में बात कर रहे हैं जो साथ काम करती है SQL सर्वर डेटाबेस और यह डेटाबेस Entity फ्रेमवर्क कोर का उपयोग करके स्वचालित रूप से बनाया गया है।

इस प्रकार, पहली शुरुआत में डेटा के साथ डेटाबेस को भरने की समस्या को हल करने के लिए, हमें आवश्यकता है:

1. NuGet प्रोजेक्ट में Korzh.DbUtils लाइब्रेरी पैकेज स्थापित करें

इस मामले में, हमें उनमें से 2 की आवश्यकता है:

Korzh.DbUtils.Import
Korzh.DbUtils.SqlServer

2. इनिशियलाइज़ेशन कोड जोड़ें

इस तरह के कोड का एक उदाहरण है जिसे हमें स्टार्टअप के अंत में जोड़ना चाहिए। कॉन्फिगर विधि:

 public void Configure(IApplicationBuilder app, IHostingEnvironment env) { . . . . app.UseMvc(); using (var scope = app.ApplicationServices.GetRequiredService<IServiceScopeFactory>().CreateScope()) using (var context = scope.ServiceProvider.GetService<AppDbContext>()) { if (context.Database.EnsureCreated()) { //run only if database was not created previously Korzh.DbUtils.DbInitializer.Create(options => { options.UseSqlServer(Configuration.GetConnectionString("DefaultConnection")); //set the connection string for our database options.UseFileFolderPacker(System.IO.Path.Combine(env.ContentRootPath, "App_Data", "SeedData")); //set the folder where to get the seeding data }) .Seed(); } } }

सब कुछ काफी सुंदर बनाने के लिए, या यदि आपको पहली शुरुआत में कुछ अतिरिक्त आरंभीकरण करने की आवश्यकता है (उदाहरण के लिए, कई उपयोगकर्ता खाते और / या उपयोगकर्ता भूमिकाएं जोड़ें), तो इंटरफ़ेस के लिए एक अलग एक्सटेंशन विधि के रूप में इस सभी कोड को व्यवस्थित करने के लिए बेहतर है (चलो इसे EnsureDbInitialized कहते हैं) IApplicationBuilder ।

इस तरह के कार्यान्वयन का एक उदाहरण इजीविक लाइब्रेरी के लिए डेमो प्रोजेक्ट में गिटहब पर पाया जा सकता है।

इस स्थिति में, आपको अपने स्टार्टअप के अंत में एक कॉल जोड़ने की आवश्यकता है। विधि को कॉन्फ़िगर करें:

 public void Configure ( IApplicationBuilder,   IHostingEnvironment) { . . . . app.UseMvc (); //Init database (only if necessary) app.EnsureDbInitialized(Configuration, env); }

भविष्य की योजना

यद्यपि पुस्तकालय और उपयोगिता को एक बहुत ही विशिष्ट परिदृश्य के तहत लिखा गया था, हमने हर संभव के रूप में लचीला और एक्स्टेंसिबल करने की कोशिश की, इसलिए अतिरिक्त कार्यक्षमता को सक्षम करना एक समस्या नहीं होगी।

संभावित सुधारों में से, हम निम्नलिखित देखते हैं:

अन्य डेटाबेस (PostgreSQL, Oracle, SQLite, MariaDB) के लिए समर्थन
नए स्वरूप जिनसे आप डेटा निर्यात कर सकते हैं (CSV, Excel, HTML)
डेटाबेस से डेटा को सीधे कॉपी करने का कार्य (अब आप इसे निर्यात / आयात कार्यक्रमों के लिए लगातार कॉल के एक जोड़े के माध्यम से लागू कर सकते हैं)
पूर्ण बैकअप / पुनर्प्राप्ति संचालन डेटाबेस संरचना के पूर्ण संरक्षण और पुनर्प्राप्ति के दौरान खरोंच से इसके निर्माण के साथ।

हमें किसी भी सुझाव या टिप्पणी को सुनकर खुशी होगी और नए सितारों के लिए GitHub लाइब्रेरी रिपॉजिटरी के लिए बहुत आभारी हैं :)

आपका ध्यान के लिए धन्यवाद!

.NET अनुप्रयोगों (कोर) में सीडिंग डेटाबेस के लिए DbTool का उपयोग करना