Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: thoroughly document DataTypes #11

Merged
merged 16 commits into from
Mar 19, 2022
Merged

docs: thoroughly document DataTypes #11

merged 16 commits into from
Mar 19, 2022

Conversation

ephys
Copy link
Member

@ephys ephys commented Mar 17, 2022

This PR rewrites the other-data-types page to thoroughly document every built-in DataType, and their corresponding SQL type (per dialect).

I based it on the DataTypes unit tests, as well as the documentation of the different dialects.
I'm unsure which documentation should be used for db2 & ibmi so there are likely errors in what I wrote for these 2 dialects. @markdirish if you have a minute to review this part, and/or point me to the right resources.

I've also documented common pain points, such as DataTypes.UUIDV4 being a JS function instead of a SQL one.

I've also moved the part about querying JSON to the page about Querying (with a link leading there), as that seems to be the place where people look for it.

I wrote a react component that filters out the columns of a table based on the user's preferred dialect :)

image

image

@ephys ephys requested a review from a team March 17, 2022 15:42
@ephys ephys self-assigned this Mar 17, 2022
@ephys
Copy link
Member Author

ephys commented Mar 17, 2022

I'll fix the lint issue but feel free to review the contents :)

Copy link
Member

@sdepold sdepold left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are the React files for?

docs/core-concepts/model-basics.md Show resolved Hide resolved
@sdepold
Copy link
Member

sdepold commented Mar 17, 2022

What are the React files for?

Ah nevermind. Cool stuff

sdepold
sdepold previously approved these changes Mar 17, 2022
@ephys
Copy link
Member Author

ephys commented Mar 17, 2022

What are the React files for?

They're two new components that can be used in mdx files:

  • Deprecated adds a 'Trash' icon next to a piece of text, & hovering the text display "this feature is deprecated"
    image
  • DialectTableFilter is used to make the support tables more readable by filtering out the dialects that don't concern you

Edit: ah, I'm too late :)

@ephys
Copy link
Member Author

ephys commented Mar 17, 2022

Before merging I've noticed the two first datatype sections don't have links to the dialect documentations like the other ones. I should fix that.

@ephys
Copy link
Member Author

ephys commented Mar 18, 2022

Links to the different dbms documentations have been added

IMO we can merge without @markdirish's review for db2/ibmi. We'll open a follow-up PR if necessary

@sdepold
Copy link
Member

sdepold commented Mar 19, 2022

lgtm

@ephys
Copy link
Member Author

ephys commented Mar 19, 2022

conflict fixed

@sdepold sdepold self-requested a review March 19, 2022 16:44
@ephys ephys changed the title Thoroughly document DataTypes docs: thoroughly document DataTypes Mar 19, 2022
@ephys ephys merged commit 5c3d637 into main Mar 19, 2022
@ephys ephys deleted the ephys/new-datatypes-docs branch March 19, 2022 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants