Add docs for how to create bacpac file

feathr-ai · Jan 11, 2023 · 2837926 · 2837926
1 parent 7d814eb
commit 2837926
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/docs/dev_guide/creating_bacpac_file.md b/docs/dev_guide/creating_bacpac_file.md
@@ -0,0 +1,21 @@
+---
+layout: default
+title: Creating the BACPAC file
+parent: Developer Guides
+---
+
+# Creating the BACPAC file
+
+BACPAC is the SQL server backup format, the BACPAC file we used in the ARM template contains empty tables with predefined schemas, which are required by the registry service. 
+
+In case you need to re-create the BACPAC file, follow these steps: 
+
+1. Create a new, empty SQL database on Azure 
+![architecture](../images/bacpac-sql-database.png)
+
+2. Connect to the database with a SQL client, such as Azure Data Studio, run the SQL script at https://github.com/linkedin/feathr/blob/main/registry/sql-registry/scripts/schema.sql 
+
+3. Now we created the tables required by the registry service, we can use “Export” function to create the BACPAC file 
+![architecture](../images/bacpac-export.png)
+
+After this step, the database is not needed anymore. 
diff --git a/docs/images/bacpac-export.png b/docs/images/bacpac-export.png
diff --git a/docs/images/bacpac-sql-database.png b/docs/images/bacpac-sql-database.png