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

Add section explaining table metadata #774

Merged
merged 10 commits into from
Sep 6, 2022
Merged

Add section explaining table metadata #774

merged 10 commits into from
Sep 6, 2022

Conversation

utkarsharma2
Copy link
Collaborator

Description

What is the current behavior?

Some of the examples are in https://astro-sdk-python.readthedocs.io/en/stable/astro/sql/operators/load_file.htm. use the metadata parameter when creating a Table, but AFAICT we don't explain what that does.

closes: #767

What is the new behavior?

Added section in docs explaining the usage of Metadata.

Does this introduce a breaking change?

No

Checklist

  • Created tests that fail without the change (if possible)
  • Extended the README/documentation, if necessary

@codecov
Copy link

codecov bot commented Sep 5, 2022

Codecov Report

Merging #774 (9529cd6) into main (e96a36a) will decrease coverage by 0.19%.
The diff coverage is n/a.

❗ Current head 9529cd6 differs from pull request most recent head a3f2f1e. Consider uploading reports for the commit a3f2f1e to get more accurate results

@@            Coverage Diff             @@
##             main     #774      +/-   ##
==========================================
- Coverage   93.39%   93.20%   -0.20%     
==========================================
  Files          43       43              
  Lines        1846     1853       +7     
  Branches      230      232       +2     
==========================================
+ Hits         1724     1727       +3     
- Misses         96       98       +2     
- Partials       26       28       +2     
Impacted Files Coverage Δ
python-sdk/src/astro/files/base.py 91.37% <0.00%> (-2.97%) ⬇️
python-sdk/src/astro/files/locations/base.py 73.68% <0.00%> (-2.00%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Collaborator

@tatiana tatiana left a comment

Choose a reason for hiding this comment

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

@utkarsharma2 it is probably worth explaining where we retrieve the metadata information from when the user doesn't set this property!

python-sdk/docs/concepts.rst Outdated Show resolved Hide resolved
python-sdk/docs/concepts.rst Outdated Show resolved Hide resolved
utkarsharma2 and others added 2 commits September 5, 2022 17:01
Co-authored-by: Tatiana Al-Chueyr <tatiana.alchueyr@gmail.com>
Co-authored-by: Tatiana Al-Chueyr <tatiana.alchueyr@gmail.com>
Copy link
Collaborator

@phanikumv phanikumv left a comment

Choose a reason for hiding this comment

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

suggest changing the tag to metadata_example_snowflake than metadata_example_1 for better readability

python-sdk/docs/concepts.rst Outdated Show resolved Hide resolved
python-sdk/docs/concepts.rst Outdated Show resolved Hide resolved
utkarsharma2 and others added 4 commits September 5, 2022 17:14
Co-authored-by: Phani Kumar <94376113+phanikumv@users.noreply.github.com>
Co-authored-by: Phani Kumar <94376113+phanikumv@users.noreply.github.com>
Co-authored-by: Phani Kumar <94376113+phanikumv@users.noreply.github.com>
Co-authored-by: Phani Kumar <94376113+phanikumv@users.noreply.github.com>
python-sdk/docs/concepts.rst Outdated Show resolved Hide resolved
utkarsharma2 and others added 2 commits September 6, 2022 15:49
Co-authored-by: Kaxil Naik <kaxilnaik@gmail.com>
python-sdk/docs/concepts.rst Outdated Show resolved Hide resolved
@kaxil kaxil merged commit 700c5c7 into main Sep 6, 2022
@kaxil kaxil deleted the MetadataDoc branch September 6, 2022 11:10
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.

Add documentation for how and when to use metadata parameter for Table
5 participants