Skip to content

Commit

Permalink
Update schema diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
betsybookwyrm committed Aug 8, 2023
1 parent 924eda9 commit f280b7a
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 17 deletions.
30 changes: 16 additions & 14 deletions docs/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,12 @@ erDiagram
integer verified
text url
text username
integer page_id PK, FK
text source_file FK
integer source_page PK, FK
text source_file PK, FK
}
"tweet_by_page" {
text id PK
integer page_id PK, FK
integer source_page PK, FK
text reply_settings
text conversation_id
text created_at
Expand All @@ -85,12 +85,12 @@ erDiagram
integer quote_count
integer reply_count
integer retweet_count
text source_file FK
text source_file PK, FK
integer directly_collected
}
"results_page" {
integer id PK
text file_name
integer page PK
text file_name PK
text oldest_id
text newest_id
integer result_count
Expand All @@ -107,9 +107,9 @@ erDiagram
user_hashtag |o--o{ user : "user"
tweet_mention |o--o{ tweet : "tweet"
user_mention |o--o{ user : "user"
user_by_page |o--o{ results_page : "page"
user_by_page |o--o{ results_page : "source page"
user_by_page |o--o{ results_page : "source file"
tweet_by_page |o--o{ results_page : "page"
tweet_by_page |o--o{ results_page : "source page"
tweet_by_page |o--o{ tweet : "retweeted tweet"
tweet_by_page |o--o{ tweet : "quoted tweet"
tweet_by_page |o--o{ tweet : "replied to tweet"
Expand Down Expand Up @@ -204,16 +204,16 @@ Table **user_by_page**:
- **verified** (integer): boolean
- **url** (text)
- **username** (text)
- **page_id** (integer primary key references results_page (id))
- **source_file** (text references results_page (file_name))
- **source_page** (integer primary key references results_page (page))
- **source_file** (text primary key references results_page (file_name))

primary key


Table **tweet_by_page**:

- **id** (text primary key )
- **page_id** (integer primary key references results_page (id))
- **source_page** (integer primary key references results_page (page))
- **reply_settings** (text)
- **conversation_id** (text)
- **created_at** (text)
Expand All @@ -230,16 +230,16 @@ Table **tweet_by_page**:
- **quote_count** (integer)
- **reply_count** (integer)
- **retweet_count** (integer)
- **source_file** (text references results_page (file_name))
- **source_file** (text primary key references results_page (file_name))
- **directly_collected** (integer): boolean

primary key


Table **results_page**:

- **id** (integer primary key)
- **file_name** (text)
- **page** (integer primary key ): page number within the file
- **file_name** (text primary key )
- **oldest_id** (text): oldest tweet id in page
- **newest_id** (text): newest tweet id in page
- **result_count** (integer): count given in API response
Expand All @@ -250,4 +250,6 @@ Table **results_page**:
- **request_url** (text)
- **additional_metadata** (text): extra metadata from twarc and twitter

primary key


6 changes: 3 additions & 3 deletions generate_schema_diagram.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import click

from tidy_tweet.tweet_mapping import create_table_statements
from tidy_tweet import database_schema
from typing import NamedTuple, List, Tuple, TextIO


Expand Down Expand Up @@ -121,7 +121,7 @@ def write_table_as_list(


def write_schema_as_lists(output: TextIO):
for statement in create_table_statements:
for statement in database_schema:
parsed_name, parsed_columns, table_comment = parse_table(statement)

write_table_as_list(output, parsed_name, parsed_columns, table_comment)
Expand All @@ -141,7 +141,7 @@ def write_schema_as_mermaid_er(output: TextIO, with_comments=True):
foreign_keys: List[ForeignKey] = []

# Table definitions
for statement in create_table_statements:
for statement in database_schema:
table_name, columns, _ = parse_table(statement)

output.write(indent + f'"{table_name}"' + " {\n")
Expand Down

0 comments on commit f280b7a

Please sign in to comment.