You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As a database developer or administrator, I want to import existing documentation into Digger so that the entire documentation gets centralized in a single place. The import logic avoids duplication, but it updates documentation fields already present.
Given the following relational model extracted from Minimily:
Here is its representation in a format that can be imported by Digger:
[{"name": "user_profile",
"friendlyName": "User Profile",
"type": "TABLE",
"documentation": "Stores user personal preferences.",
"columns": [
{"name": "id",
"friendlyName": "Identifier",
"type": "integer(10)",
"nullable": "false",
"documentation": "Unique identifier auto-generated by the database."},
{"name": "user_account",
"friendlyName": "User Account",
"type": "integer(10)",
"nullable": "false",
"foreignTable": "user_account",
"foreignColumn": "id",
"documentation": "The user account that the profile belongs to."},
{"name": "first_name",
"friendlyName": "First Name",
"type": "varchar(30)",
"nullable": "false",
"documentation": "The first name of the full name"},
{"name": "last_name",
"friendlyName": "Last Name",
"type": "varchar(30)",
"nullable": "false",
"documentation": "The last name of the full name"},
{"name": "email",
"friendlyName": "Email",
"type": "varchar(100)",
"nullable": "false",
"documentation": "Unique email address"}]},
{"name": "family",
"friendlyName": "Family",
"type": "TABLE",
"documentation": "Defines a family.",
"columns": [
{"name": "id",
"friendlyName": "Identifier",
"type": "integer(10)",
"nullable": "false",
"documentation": "Unique identifier auto-generated by the database."},
{"name": "name",
"friendlyName": "Name",
"type": "varchar(100)",
"nullable": "false",
"documentation": "Name of the family."},
{"name": "profile",
"friendlyName": "Profile",
"type": "integer(10)",
"nullable": "false",
"foreignTable": "user_profile",
"foreignColumn": "id",
"documentation": "The profile that created the family."}]},
{"name": "family_member",
"friendlyName": "Family Member",
"type": "TABLE",
"documentation": "Defines a user profile as member of the family."},
"columns": [
{"name": "id",
"friendlyName": "Identifier",
"type": "integer(10)",
"nullable": "false",
"documentation": "Unique identifier auto-generated by the database."},
{"name": "family",
"friendlyName": "Family",
"type": "integer(10)",
"nullable": "false",
"foreignTable": "family",
"foreignColumn": "id",
"documentation": "Family of the user profile."},
{"name": "user_profile",
"friendlyName": "User Profile",
"type": "integer(10)",
"nullable": "false",
"foreignTable": "user_profile",
"foreignColumn": "id",
"documentation": "The profile that belongs to the family."},
{"name": "organizer",
"friendlyName": "Organizer",
"type": "tinyint(1)",
"nullable": "true",
"documentation": "Indicates that the user profile is the organizer of the family."}]}]
When defining a table, only the name is required. When defining a column, the name, type, size, and nullable are required.
A table with name as the only attribute and without columns is considered as a table to be ignored. For example:
{"name": "CATALOGS"}
The text was updated successfully, but these errors were encountered:
As a database developer or administrator, I want to import existing documentation into Digger so that the entire documentation gets centralized in a single place. The import logic avoids duplication, but it updates documentation fields already present.
Given the following relational model extracted from Minimily:
Here is its representation in a format that can be imported by Digger:
When defining a table, only the
name
is required. When defining a column, thename
,type
,size
, andnullable
are required.A table with
name
as the only attribute and without columns is considered as a table to be ignored. For example:The text was updated successfully, but these errors were encountered: