airbnb/caravel

View on GitHub
scripts/templates/erd.plantuml.template

Summary

Maintainability
Test Coverage
{#
  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.
#}
@startuml entity-relationship-diagram

title Apache Superset ERD

!theme blueprint

' avoid problems with angled crows feet

skinparam linetype ortho
skinparam classBorderColor #grey

skinparam classBorderColor<<new>> #white
skinparam classBorderThickness<<new>> 1
skinparam classLineStyle<<new>> Dashed
skinparam ClassBackgroundColor<<new>> #204143

' Models
{% for group_name, models in data.items() -%}
    rectangle "{{ group_name }}" #black {
        {% for model in models -%}
        entity "{{ model.class_name }} ({{ model.table_name }})" as {{ model.table_name }} {
            {%- for field in model.fields %}
            {{ field.field_name }}: {{ field.type -}}
            {%- endfor %}
        }
        {% endfor -%}
    }
{% endfor -%}

' Relationships
{% for models in data.values() -%}
{% for model in models -%}
    {%- for rel in model.relationships %}
    {{ model.table_name }} {{ rel.squiggle }} {{ rel.related_table }}
    {%- endfor %}
{% endfor -%}
{% endfor -%}

@enduml