This is an automated email from the ASF dual-hosted git repository.
jbonofre pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris-site.git
The following commit(s) were added to refs/heads/main by this push:
new 7c4a849 Fix broken links by removing some references
7c4a849 is described below
commit 7c4a84934dc6ebdd7c4aa5c55bcea05e4580711f
Author: JB Onofré <[email protected]>
AuthorDate: Sat Aug 31 07:22:37 2024 +0200
Fix broken links by removing some references
---
docs/entities.md | 24 ++++--------------------
1 file changed, 4 insertions(+), 20 deletions(-)
diff --git a/docs/entities.md b/docs/entities.md
index 0b855db..3d0374e 100644
--- a/docs/entities.md
+++ b/docs/entities.md
@@ -6,48 +6,32 @@ This page documents various entities that can be managed in
Apache Polaris (Incu
A catalog is a top-level entity in Polaris that may contain other entities
like [namespaces](#namespace) and [tables](#table). These map directly to
[Apache Iceberg catalogs](https://iceberg.apache.org/concepts/catalog/).
-For information on managing catalogs with the REST API or for more information
on what data can be associated with a catalog, see [the API
docs](../regtests/client/python/docs/CreateCatalogRequest.md).
-
### Storage Type
All catalogs in Polaris are associated with a _storage type_. Valid Storage
Types are `S3`, `Azure`, and `GCS`. The `FILE` type is also additionally
available for testing. Each of these types relates to a different storage
provider where data within the catalog may reside. Depending on the storage
type, various other configurations may be set for a catalog including
credentials to be used when accessing data inside the catalog.
-For details on how to use Storage Types in the REST API, see [the API
docs](../regtests/client/python/docs/StorageConfigInfo.md).
-
## Namespace
A namespace is a logical entity that resides within a [catalog](#catalog) and
can contain other entities such as [tables](#table) or [views](#view). Some
other systems may refer to namespaces as _schemas_ or _databases_.
In Polaris, namespaces can be nested. For example, `a.b.c.d.e.f.g` is a valid
namespace. `b` is said to reside within `a`, and so on.
-For information on managing namespaces with the REST API or for more
information on what data can be associated with a namespace, see [the API
docs](../regtests/client/python/docs/CreateNamespaceRequest.md).
-
-
## Table
Polaris tables are entities that map to [Apache Iceberg
tables](https://iceberg.apache.org/docs/nightly/configuration/).
-For information on managing tables with the REST API or for more information
on what data can be associated with a table, see [the API
docs](../regtests/client/python/docs/CreateTableRequest.md).
-
## View
Polaris views are entities that map to [Apache Iceberg
views](https://iceberg.apache.org/view-spec/).
-For information on managing views with the REST API or for more information on
what data can be associated with a view, see [the API
docs](../regtests/client/python/docs/CreateViewRequest.md).
-
## Principal
Polaris principals are unique identities that can be used to represent users
or services. Each principal may have one or more [principal
roles](#principal-role) assigned to it for the purpose of accessing catalogs
and the entities within them.
-For information on managing principals with the REST API or for more
information on what data can be associated with a principal, see [the API
docs](../regtests/client/python/docs/CreatePrincipalRequest.md).
-
## Principal Role
Polaris principal roles are labels that may be granted to
[principals](#principal). Each principal may have one or more principal roles,
and the same principal role may be granted to multiple principals. Principal
roles may be assigned based on the persona or responsibilities of a given
principal, or on how that principal will need to access different entities
within Polaris.
-For information on managing principal roles with the REST API or for more
information on what data can be associated with a principal role, see [the API
docs](../regtests/client/python/docs/CreatePrincipalRoleRequest.md).
-
-
## Catalog Role
Polaris catalog roles are labels that may be granted to [catalogs](#catalog).
Each catalog may have one or more catalog roles, and the same catalog role may
be granted to multiple catalogs. Catalog roles may be assigned based on the
nature of data that will reside in a catalog, or by the groups of users and
services that might need to access that data.
@@ -61,7 +45,7 @@ Polaris privileges are granted to [catalog
roles](#catalog-role) in order to gra
A privilege can be scoped to any entity inside a catalog, including the
catalog itself.
For a list of supported privileges for each privilege class, see the API docs:
-* [Table Privileges](../regtests/client/python/docs/TablePrivilege.md)
-* [View Privileges](../regtests/client/python/docs/ViewPrivilege.md)
-* [Namespace Privileges](../regtests/client/python/docs/NamespacePrivilege.md)
-* [Catalog Privileges](../regtests/client/python/docs/CatalogPrivilege.md)
+* Table Privileges
+* View Privileges
+* Namespace Privileges
+* Catalog Privileges
