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

HDDS-11947. [Docs] [User Guide] Impala Integration. #7584

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

jojochuang
Copy link
Contributor

@jojochuang jojochuang commented Dec 17, 2024

What changes were proposed in this pull request?

HDDS-11947. [Docs] [User Guide] Impala Integration.

Adding the doc to the old user doc site.

Please describe your PR in detail:

What is the link to the Apache JIRA

https://issues.apache.org/jira/browse/HDDS-11947

How was this patch tested?

./hadoop-ozone/dev-support/checks/docs.sh passed.

https://github.com/jojochuang/ozone/actions/runs/12364445561

Screenshot 2024-12-16 at 7 57 10 PM Screenshot 2024-12-16 at 7 54 46 PM

Change-Id: Ic09028a519199274093186b611963ebb8bfb7879
@adoroszlai adoroszlai added the documentation Improvements or additions to documentation label Dec 18, 2024
Copy link
Contributor

@adoroszlai adoroszlai left a comment

Choose a reason for hiding this comment

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

Thanks @jojochuang for documenting this.

hadoop-hdds/docs/content/integration/_index.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/integration/_index.md Outdated Show resolved Hide resolved
Copy link
Contributor

@errose28 errose28 left a comment

Choose a reason for hiding this comment

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

Thanks for adding this @jojochuang. I think we should try to standardize the layout of the integration pages a little more. For example the way the proposed Impala and Hive pages mention supported protocols, replication types, bucket types, etc is different.

hadoop-hdds/docs/content/integration/Impala.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/integration/Impala.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/integration/Impala.md Outdated Show resolved Hide resolved
Change-Id: I30a10b188276987558e5d8879b45a48b65ea6740
@jojochuang
Copy link
Contributor Author

Thanks for the in-depth review! Updated the doc and here's the screenshot:

Screenshot 2024-12-20 at 10 59 13 AM Screenshot 2024-12-20 at 10 59 25 AM

Change-Id: I33bb688d70b10bf616dfd4eef20775591cc53e40
Copy link
Contributor

@MikaelSmith MikaelSmith left a comment

Choose a reason for hiding this comment

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

As an Impala committer, I think this looks good and appreciate having it added to the Ozone docs.

Copy link
Contributor

@adoroszlai adoroszlai left a comment

Choose a reason for hiding this comment

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

Thanks @jojochuang for updating the patch. Few formatting suggestions based on looking at the rendered version.

hadoop-hdds/docs/content/integration/Impala.md Outdated Show resolved Hide resolved

Starting with version 4.2.0, Apache Impala provides full support for querying data stored in Apache Ozone. To utilize this functionality, ensure that your Ozone version is 1.4.0 or later.

# Supported Access Protocols
Copy link
Contributor

Choose a reason for hiding this comment

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

Impala is rendered as h1, so I think these sections should be h2.

Suggested change
# Supported Access Protocols
## Supported Access Protocols


Note: The o3fs protocol is **NOT** supported by Impala.

# Supported Replication Types
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# Supported Replication Types
## Supported Replication Types

* RATIS (Replication)
* Erasure Coding

# Querying Ozone Data with Impala
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# Querying Ozone Data with Impala
## Querying Ozone Data with Impala

* Managed Tables
* External Tables

## Managed Tables
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## Managed Tables
### Managed Tables

* Note: Dropping an external table in Impala does not delete the associated data.


# Using the S3A Protocol
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# Using the S3A Protocol
## Using the S3A Protocol

If the Hive Warehouse Directory is located in Ozone, you can execute Impala queries without any changes, treating the Ozone file system like HDFS. For example:

```sql
CREATE DATABASE d1;
Copy link
Contributor

Choose a reason for hiding this comment

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

The CREATE EXTERNAL TABLE example is not indented, so I think the others can be unindented as well.

Suggested change
CREATE DATABASE d1;
CREATE DATABASE d1;

```

```sql
CREATE TABLE t1 (x INT, s STRING);
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
CREATE TABLE t1 (x INT, s STRING);
CREATE TABLE t1 (x INT, s STRING);

You can create managed databases, tables, or partitions at a specific Ozone path using the `LOCATION` clause. Example:

```sql
CREATE DATABASE d1 LOCATION 'ofs://ozone1/vol1/bucket1/d1.db';
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
CREATE DATABASE d1 LOCATION 'ofs://ozone1/vol1/bucket1/d1.db';
CREATE DATABASE d1 LOCATION 'ofs://ozone1/vol1/bucket1/d1.db';

```

```sql
CREATE TABLE t1 LOCATION 'ofs://ozone1/vol1/bucket1/table1';
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
CREATE TABLE t1 LOCATION 'ofs://ozone1/vol1/bucket1/table1';
CREATE TABLE t1 LOCATION 'ofs://ozone1/vol1/bucket1/table1';

jojochuang and others added 2 commits January 8, 2025 09:57
Change-Id: Ia3bac190ab03fc275cde4f72d5d6f8fbf73bd1fd
@jojochuang
Copy link
Contributor Author

Screenshot 2025-01-08 at 10 06 09 AM Screenshot 2025-01-08 at 10 06 17 AM

Copy link
Contributor

@errose28 errose28 left a comment

Choose a reason for hiding this comment

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

Thanks for the updates Wei-Chiu. Format LGTM and @MikaelSmith has provided a good endorsement that the content is correct.

One thing to consider before merging, should we leave this page as draft (a front matter key indicating it will not be published to the final site) until we get more integration pages completed? I think the current layout makes it look like Impala is the only supported Ozone integration.

@jojochuang
Copy link
Contributor Author

That's a good point. Hmm it doesn't really work the way it's supposed to be though. It still shows up on the side menu.
Screenshot 2025-01-08 at 10 26 07 AM

@jojochuang
Copy link
Contributor Author

Ah nvm i know what's going on. Updating it.

Change-Id: I3006e8dc7bf8b0f1a55f16ccc3da8555c1d231e9
@adoroszlai
Copy link
Contributor

One thing to consider before merging, should we leave this page as draft (a front matter key indicating it will not be published to the final site) until we get more integration pages completed? I think the current layout makes it look like Impala is the only supported Ozone integration.

With draft the page will not be rendered at all, so the content is not checked for syntax errors. Hugo provides some other options to hide content.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants