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 README content #4

Merged
merged 2 commits into from
Mar 5, 2024
Merged

Add README content #4

merged 2 commits into from
Mar 5, 2024

Conversation

N-o-Z
Copy link
Member

@N-o-Z N-o-Z commented Mar 5, 2024

No description provided.

@N-o-Z N-o-Z requested a review from a team March 5, 2024 13:26
@N-o-Z N-o-Z self-assigned this Mar 5, 2024
Copy link

@itaiad200 itaiad200 left a comment

Choose a reason for hiding this comment

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

I <3 Docs


lakeFS Catalog is using lakeFS HadoopFileSystem under the hood to interact with lakeFS.
In addition, for better performance we configure the S3A FS to interact directly with the underlying storage:

Choose a reason for hiding this comment

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

A link for lakeFSFS wiki page?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes

README.md Outdated
Comment on lines 30 to 32
conf.set("spark.hadoop.fs.lakefs.secret.key", "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY")
conf.set("spark.hadoop.fs.lakefs.endpoint", "http://localhost:8000/api/v1")

Choose a reason for hiding this comment

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

Why not keeping the same pattern <your-lakefs-endpoint>?

README.md Outdated
Comment on lines 39 to 43
conf.set("spark.sql.catalog.lakefs", "org.apache.iceberg.spark.SparkCatalog")
conf.set("spark.sql.catalog.lakefs.catalog-impl", "io.lakefs.iceberg.LakeFSCatalog")
conf.set("spark.sql.catalog.lakefs.warehouse", "lakefs://")
```

Choose a reason for hiding this comment

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

Maybe add a note explaining why we need all of these? the last 2 don't seem trivial

Copy link
Member Author

Choose a reason for hiding this comment

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

Added some more comments - though the configuration should be familiar for iceberg users

README.md Outdated
### Create a table

Let's create a table called `table1` under `main` branch and namespace `name.space.`

Choose a reason for hiding this comment

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

Suggested change
Let's create a table called `table1` under `main` branch and namespace `name.space.`
Let's create a table called `table1` under `main` branch and namespace `name.space`


```sql
CREATE TABLE lakefs.myrepo.main.name.space.table1 (id int, data string);

Choose a reason for hiding this comment

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

id and string are too confusing examples. It took me a minute to understand it's not something I need to fetch from somewhere. Can we do something stupid like animal and color?

| 2 | data2|
+----+------+
```

Choose a reason for hiding this comment

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

Do you think we should discuss merge? It will come up soon, shouldn't we explain about what supported and what ain't?

Copy link
Member Author

Choose a reason for hiding this comment

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

Will add information about merge but no example as we don't want to go into the realms of lakefs / clients.

@N-o-Z N-o-Z merged commit c4ea836 into main Mar 5, 2024
1 check passed
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.

2 participants