-
Notifications
You must be signed in to change notification settings - Fork 379
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
[#2879] feat(docs): Add doc for Doris catalog #3051
Conversation
b5d0fcf
to
446fe99
Compare
docs/assets/webui/props-doris.png
Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you provide a clearer screenshot here, the picture you provided is just a typical JDBC catalog creation page.
it seems unrelated to Doris.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done. Please take a look again.
### Catalog capabilities | ||
|
||
- Gravitino catalog corresponds to the Doris instance. | ||
- Supports metadata management of Doris (1.2.x). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does version 1.2.x
is the mostly used version currently?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doris 2.x version utilizes a vectorized engine. Xiaomi is still in the testing phase and has not officially used it yet.
Also, there are updates in Doris 2 metadata, such as auto-increment column.
We could consider supporting Doris 2 later
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, let's change it after we have thoroughly tested other versions.
docs/jdbc-doris-catalog.md
Outdated
|
||
### Table operations | ||
|
||
Refer to [Manage Relational Metadata Using Gravitino](./manage-relational-metadata-using-gravitino.md#table-operations) for more details. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please xxxx
5398346
to
3937e03
Compare
@jerryshao |
…on more accurate (#3060) ### What changes were proposed in this pull request? - postpone default schema creation after admin client - reduced exception nesting ### Why are the changes needed? Fix: #3015 ### Does this PR introduce _any_ user-facing change? yes, when the Kafka catalog creation fails, use the correct error message ### How was this patch tested? IT added
Yeah, I will. |
docs/jdbc-doris-catalog.md
Outdated
|
||
### Schema properties | ||
|
||
- Support schema properties |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What kind of schema properties do we support currently?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs updated. Support schema properties, includes Doris database properties and user-defined properties.
docs/jdbc-doris-catalog.md
Outdated
|
||
### Table properties | ||
|
||
Doris supports table properties, and you can set them in the table properties. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What kind of table properties do we support?
docs/jdbc-doris-catalog.md
Outdated
:::info | ||
- Not all table alteration operations can be processed in batch. | ||
- Schema change, such as add/modify/drop columns can be processed in batch | ||
- Can modify multi column comments at same time |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Support modify multiple column comments at the same time.
docs/jdbc-doris-catalog.md
Outdated
- Not all table alteration operations can be processed in batch. | ||
- Schema change, such as add/modify/drop columns can be processed in batch | ||
- Can modify multi column comments at same time | ||
- You can't modify the column type and column comment at the same time |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doesn't support modify...
48668f7
to
9e6f28e
Compare
@jerryshao Doc has been updated. Please help to review again, thanks. |
docs/jdbc-doris-catalog.md
Outdated
|
||
### Catalog properties | ||
|
||
You can pass to a Doris data source any property that isn't defined by Gravitino by adding `gravitino.bypass` prefix as a catalog property. For example, catalog property `gravitino.bypass.maxWaitMillis` will pass `maxWaitMillis` to the data source property. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually it should be "gravitino.bypass.", right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let me help you polish the doc.
docs/jdbc-doris-catalog.md
Outdated
|
||
- Gravitino's table concept corresponds to the Doris table. | ||
- Supports index. | ||
- Supports [column default value](./manage-relational-metadata-using-gravitino.md#table-column-default-value) and [auto-increment](./manage-relational-metadata-using-gravitino.md#table-column-auto-increment).. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You mentioned that we don't support auto-increment for now in the below, but here it says it supports auto-increment, so which one is correct? @zhoukangcn @yuqi1129
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, It's a mistake here. I will update doc today
…xception more accurate (apache#3060) ### What changes were proposed in this pull request? - postpone default schema creation after admin client - reduced exception nesting ### Why are the changes needed? Fix: apache#3015 ### Does this PR introduce _any_ user-facing change? yes, when the Kafka catalog creation fails, use the correct error message ### How was this patch tested? IT added
### What changes were proposed in this pull request? Add doc for Doris catalog ### Why are the changes needed? Fix: apache#2879 ### Does this PR introduce _any_ user-facing change? N/A ### How was this patch tested? N/A --------- Co-authored-by: Jerry Shao <[email protected]>
What changes were proposed in this pull request?
Add doc for Doris catalog
Why are the changes needed?
Fix: #2879
Does this PR introduce any user-facing change?
N/A
How was this patch tested?
N/A