[GitHub] [airflow] potiuk commented on a diff in pull request #26217: Add automatically generated ERD schema for the MetaData DB

[GitBox <gi...@apache.org>]

potiuk commented on code in PR #26217:
URL: https://github.com/apache/airflow/pull/26217#discussion_r965110821


##########
docs/apache-airflow/database-erd-ref.rst:
##########
@@ -0,0 +1,23 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+ERD Schema of the Database
+''''''''''''''''''''''''''
+
+Here is the current Database schema diagram.

Review Comment:
   I thought the same: `dev` initially. That would be "good enough" for many cases.
   
   But then I looked at our docs and - we already have db migrations in public docs. Somehow we already decided that we need to make this part "public" and make our users aware of that (and we have the CLI commands. And somehow, those migrations require the users to know "A little" about our database - to know what state it is in and understand informationa about those tables changed. 
   
   We also do some of the troubleshooting that is coming (I added it recently as a desperate attempt of having something that I can direct poor MySQL users to) - with more of the information about handling - mainly MySQL - migration problems: https://github.com/apache/airflow/blob/main/docs/apache-airflow/installation/upgrading.rst#handling-migration-problems
   
   So this "Airlfow DB is internal" abstraction is already leaky like crazy :). 
   
   I think adding this page in the public docs is quite natural consequence of those and is better than not publishing it (because of all the other information we already publish), but indeed adding a disclaimer that this DB structure  is internal and might change at any time, is probably best.
   
   WDYT?
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org