Skip to content

Commit 3335868

Browse files
committed
Code review
1 parent 5735f2c commit 3335868

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,12 @@ The fields in the table below can be used in these parts of STAC documents:
3434
| table:primary_datetime | string | The primary date/time column name. |
3535
| table:row_count | number | The number of rows in the dataset. |
3636

37+
### table:primary_geometry
38+
39+
This is the column name of the "primary" or "active" geometry. This is used by libraries like [geopandas] and [sf]
40+
to control which geometry column is used. When a STAC item uses both the [projection] and `table` extensions, it's understood that the
41+
values in `proj:espg`, `proj:bbox`, etc. that (implicitly) apply to the asset refer to the `primary_geometry` column.
42+
3743
---
3844

3945
The fields in the table below can be used in these parts of STAC documents:
@@ -44,6 +50,14 @@ The fields in the table below can be used in these parts of STAC documents:
4450
| ---------------------- | ----------------------------------- | ----------- |
4551
| table:storage_options | Map<string, any> | **DEPRECATED** Additional keywords for opening the dataset. |
4652

53+
### table:storage_options
54+
55+
This can be used with [fsspec](https://filesystem-spec.readthedocs.io/en/latest/) to specify additional keywords
56+
necessary to open the data. For example, an asset might use ``{"account_name": "ai4edataeuwest"}`` to indicate that the asset is
57+
in the ``ai4edataeuwest`` storage account. Libraries like [adlfs](https://github.com/dask/adlfs) use this information to open the dataset.
58+
59+
A potential alternative for storage options could be the [Storage Extension](https://github.com/stac-extensions/storage).
60+
4761
---
4862

4963
The fields in the table below can be used in these parts of STAC documents:
@@ -57,21 +71,11 @@ having to include column-level metadata from each table on the Collection.
5771

5872
| Field Name | Type | Description |
5973
| ------------ | ------------------------------------------ | ------------------------------------------ |
60-
| table:tables | Map<string, [Table Object](#table-object)> | **DEPRECATED** A mapping of table names to |
74+
| table:tables | Map<string, [Table Object](#table-object)> | **DEPRECATED** A mapping of table names to Table Objects (see below). |
6175

62-
### table:primary_geometry
63-
64-
This is the column name of the "primary" or "active" geometry. This is used by libraries like [geopandas] and [sf]
65-
to control which geometry column is used. When a STAC item uses both the [projection] and `table` extensions, it's understood that the
66-
values in `proj:espg`, `proj:bbox`, etc. that (implicitly) apply to the asset refer to the `primary_geometry` column.
67-
68-
### table:storage_options
69-
70-
This can be used with [fsspec](https://filesystem-spec.readthedocs.io/en/latest/) to specify additional keywords
71-
necessary to open the data. For example, an asset might use ``{"account_name": "ai4edataeuwest"}`` to indicate that the asset is
72-
in the ``ai4edataeuwest`` storage account. Libraries like [adlfs](https://github.com/dask/adlfs) use this information to open the dataset.
76+
---
7377

74-
### Column Object
78+
## Column Object
7579

7680
Column objects contain information about each colum in the table.
7781

@@ -91,7 +95,7 @@ can be used in the Column Object.
9195
Columns can also include additional information from other extensions that are not otherwise covered on the asset-level
9296
and are column specific, e.g. [projection] extension information for additional geometry columns.
9397

94-
#### geometry_type
98+
### geometry_type
9599

96100
Describes the geometry type provided by the column. Do not provide the property, if mixed geometry types occur.
97101

@@ -104,7 +108,7 @@ Must be one of the GeoJSON geometry types:
104108
- `Polygon`
105109
- `MultiPolygon`
106110

107-
### Table Object
111+
## Table Object
108112

109113
**DEPRECATED:** Table objects contain high-level summaries about a table.
110114

0 commit comments

Comments
 (0)