Manage collections¶
This notebook demonstrates how to create, update, and extend data collections in the xcube geoDB.
In [1]:
Copied!
from xcube_geodb.core.geodb import GeoDBClient
from xcube_geodb.core.geodb import GeoDBClient
In [20]:
Copied!
### uncomment if not in managed environment
#client_id=YourID
#client_secret=YourSecret
#geodb = GeoDBClient(client_id=client_id, client_secret=client_secret, auth_mode="client-credentials")
### uncomment if not in managed environment
#client_id=YourID
#client_secret=YourSecret
#geodb = GeoDBClient(client_id=client_id, client_secret=client_secret, auth_mode="client-credentials")
Login in managed environment¶
The environment is prepared with your user credentials, so you simply can start the client.
In [ ]:
Copied!
geodb = GeoDBClient()
geodb = GeoDBClient()
Get your user name¶
In [5]:
Copied!
geodb.whoami
geodb.whoami
Out[5]:
'geodb_ci_test_user'
In [6]:
Copied!
# Lets get already existing collections
ds = geodb.get_my_collections()
ds
# Lets get already existing collections
ds = geodb.get_my_collections()
ds
Out[6]:
| owner | database | table_name | |
|---|---|---|---|
| 0 | geodb_9bfgsdfg-453f-445b-a459 | geodb_9bfgsdfg-453f-445b-a459 | land_use |
| 1 | tt | tt | tt300 |
Creating collections¶
Once the connection has been established you will be able to create a collection. The collection will contain standard properties (fields) plus custom properties which you can add at your discretion. Please use PostGreSQL type definitions. We recommend stying simple with your data types as we have not tested every single type.
In [7]:
Copied!
# Have a look at fiona feature schema
collections = {
"land_use":
{
"crs": 3794,
"properties":
{
"RABA_PID": "float",
"RABA_ID": "float",
"D_OD": "date"
}
}
}
geodb.create_collections(collections, clear=True)
# Have a look at fiona feature schema
collections = {
"land_use":
{
"crs": 3794,
"properties":
{
"RABA_PID": "float",
"RABA_ID": "float",
"D_OD": "date"
}
}
}
geodb.create_collections(collections, clear=True)
Out[7]:
{'collections': {'geodb_ci_test_user_land_use': {'crs': 3794,
'properties': {'D_OD': 'date',
'RABA_ID': 'float',
'RABA_PID': 'float'}}}}
Loading data into a dataset¶
Once the table has been created, you can load data into the dataset. The example below loads a shapefile. The attributes of the shapefile correspond to the dataset's properties.
In [7]:
Copied!
import geopandas
gdf = geopandas.read_file('data/sample/land_use.shp')
gdf
import geopandas
gdf = geopandas.read_file('data/sample/land_use.shp')
gdf
Out[7]:
| RABA_PID | RABA_ID | D_OD | geometry | |
|---|---|---|---|---|
| 0 | 4770326.0 | 1410 | 2019-03-26 | POLYGON ((453952.629 91124.177, 453952.696 911... |
| 1 | 4770325.0 | 1300 | 2019-03-26 | POLYGON ((453810.376 91150.199, 453812.552 911... |
| 2 | 2305689.0 | 7000 | 2019-02-25 | POLYGON ((456099.635 97696.070, 456112.810 976... |
| 3 | 2305596.0 | 1100 | 2019-02-25 | POLYGON ((455929.405 97963.785, 455933.284 979... |
| 4 | 2310160.0 | 1100 | 2019-03-11 | POLYGON ((461561.512 96119.256, 461632.114 960... |
| ... | ... | ... | ... | ... |
| 9822 | 6253989.0 | 1600 | 2019-03-08 | POLYGON ((460637.334 96865.891, 460647.927 969... |
| 9823 | 6252044.0 | 1600 | 2019-03-26 | POLYGON ((459467.868 96839.686, 459467.770 968... |
| 9824 | 6245985.0 | 2000 | 2019-04-08 | POLYGON ((459488.998 94066.248, 459498.145 940... |
| 9825 | 6245986.0 | 2000 | 2019-02-20 | POLYGON ((459676.680 94000.000, 459672.469 939... |
| 9826 | 6245987.0 | 2000 | 2019-03-11 | POLYGON ((459690.580 94042.607, 459686.872 940... |
9827 rows × 4 columns
In [8]:
Copied!
geodb.insert_into_collection('land_use', gdf.iloc[:100,:]) # minimizing rows to 100, if you are in EDC, you dont need to make the subset.
geodb.insert_into_collection('land_use', gdf.iloc[:100,:]) # minimizing rows to 100, if you are in EDC, you dont need to make the subset.
Out[8]:
Data inserted into land_use
In [10]:
Copied!
geodb.get_collection('land_use', query="raba_id=eq.7000")
geodb.get_collection('land_use', query="raba_id=eq.7000")
Out[10]:
| id | created_at | modified_at | geometry | raba_pid | raba_id | d_od | |
|---|---|---|---|---|---|---|---|
| 0 | 3 | 2021-01-22T10:13:54.418035+00:00 | None | POLYGON ((456099.635 97696.070, 456112.810 976... | 2305689 | 7000 | 2019-02-25 |
| 1 | 26 | 2021-01-22T10:13:54.418035+00:00 | None | POLYGON ((459898.930 100306.841, 459906.288 10... | 2301992 | 7000 | 2019-04-06 |
| 2 | 95 | 2021-01-22T10:13:54.418035+00:00 | None | POLYGON ((459591.248 92619.056, 459592.745 926... | 2333229 | 7000 | 2019-02-20 |
Delete from a Collection¶
In [11]:
Copied!
geodb.delete_from_collection('land_use', query="raba_id=eq.7000")
geodb.delete_from_collection('land_use', query="raba_id=eq.7000")
Out[11]:
Data from land_use deleted
In [12]:
Copied!
geodb.get_collection('land_use', query="raba_id=eq.7000")
geodb.get_collection('land_use', query="raba_id=eq.7000")
Out[12]:
| Empty Result |
|---|
Updating a Collection¶
In [13]:
Copied!
geodb.get_collection('land_use', query="raba_id=eq.1300")
geodb.get_collection('land_use', query="raba_id=eq.1300")
Out[13]:
| id | created_at | modified_at | geometry | raba_pid | raba_id | d_od | |
|---|---|---|---|---|---|---|---|
| 0 | 2 | 2021-01-22T10:13:54.418035+00:00 | None | POLYGON ((453810.376 91150.199, 453812.552 911... | 4770325 | 1300 | 2019-03-26 |
| 1 | 10 | 2021-01-22T10:13:54.418035+00:00 | None | POLYGON ((456547.427 91543.640, 456544.255 915... | 2318555 | 1300 | 2019-03-14 |
| 2 | 63 | 2021-01-22T10:13:54.418035+00:00 | None | POLYGON ((456201.531 98685.274, 456199.109 986... | 2304287 | 1300 | 2019-02-25 |
| 3 | 86 | 2021-01-22T10:13:54.418035+00:00 | None | POLYGON ((454709.766 97354.278, 454704.878 973... | 2331038 | 1300 | 2019-01-05 |
| 4 | 87 | 2021-01-22T10:13:54.418035+00:00 | None | POLYGON ((453820.737 98574.017, 453816.740 985... | 2357574 | 1300 | 2019-01-16 |
| 5 | 92 | 2021-01-22T10:13:54.418035+00:00 | None | POLYGON ((461723.552 99635.913, 461729.649 996... | 2332405 | 1300 | 2019-03-27 |
In [14]:
Copied!
geodb.update_collection('land_use', query="raba_id=eq.1300", values={'d_od': '2000-01-01'})
geodb.update_collection('land_use', query="raba_id=eq.1300", values={'d_od': '2000-01-01'})
Out[14]:
land_use updated
In [15]:
Copied!
geodb.get_collection('land_use', query="raba_id=eq.1300")
geodb.get_collection('land_use', query="raba_id=eq.1300")
Out[15]:
| id | created_at | modified_at | geometry | raba_pid | raba_id | d_od | |
|---|---|---|---|---|---|---|---|
| 0 | 10 | 2021-01-22T10:13:54.418035+00:00 | 2021-01-22T10:15:11.329375+00:00 | POLYGON ((456547.427 91543.640, 456544.255 915... | 2318555 | 1300 | 2000-01-01 |
| 1 | 86 | 2021-01-22T10:13:54.418035+00:00 | 2021-01-22T10:15:11.329375+00:00 | POLYGON ((454709.766 97354.278, 454704.878 973... | 2331038 | 1300 | 2000-01-01 |
| 2 | 2 | 2021-01-22T10:13:54.418035+00:00 | 2021-01-22T10:15:11.329375+00:00 | POLYGON ((453810.376 91150.199, 453812.552 911... | 4770325 | 1300 | 2000-01-01 |
| 3 | 63 | 2021-01-22T10:13:54.418035+00:00 | 2021-01-22T10:15:11.329375+00:00 | POLYGON ((456201.531 98685.274, 456199.109 986... | 2304287 | 1300 | 2000-01-01 |
| 4 | 87 | 2021-01-22T10:13:54.418035+00:00 | 2021-01-22T10:15:11.329375+00:00 | POLYGON ((453820.737 98574.017, 453816.740 985... | 2357574 | 1300 | 2000-01-01 |
| 5 | 92 | 2021-01-22T10:13:54.418035+00:00 | 2021-01-22T10:15:11.329375+00:00 | POLYGON ((461723.552 99635.913, 461729.649 996... | 2332405 | 1300 | 2000-01-01 |
Managing Properties of a Collection¶
In [16]:
Copied!
geodb.get_my_collections()
geodb.get_my_collections()
Out[16]:
| owner | database | table_name | |
|---|---|---|---|
| 0 | geodb_9bfgsdfg-453f-445b-a459 | geodb_9bfgsdfg-453f-445b-a459 | land_use |
| 1 | geodb_ci_test_user | geodb_ci_test_user | land_use |
| 2 | tt | tt | tt300 |
In [17]:
Copied!
geodb.get_properties('land_use')
geodb.get_properties('land_use')
Out[17]:
| database | table_name | column_name | data_type | |
|---|---|---|---|---|
| 0 | geodb_ci_test_user | land_use | id | integer |
| 1 | geodb_ci_test_user | land_use | created_at | timestamp with time zone |
| 2 | geodb_ci_test_user | land_use | modified_at | timestamp with time zone |
| 3 | geodb_ci_test_user | land_use | geometry | USER-DEFINED |
| 4 | geodb_ci_test_user | land_use | raba_pid | double precision |
| 5 | geodb_ci_test_user | land_use | raba_id | double precision |
| 6 | geodb_ci_test_user | land_use | d_od | date |
In [18]:
Copied!
geodb.add_property('land_use', "test_prop", 'integer')
geodb.add_property('land_use', "test_prop", 'integer')
Out[18]:
Properties added
In [19]:
Copied!
geodb.get_properties('land_use')
geodb.get_properties('land_use')
Out[19]:
| database | table_name | column_name | data_type | |
|---|---|---|---|---|
| 0 | geodb_ci_test_user | land_use | id | integer |
| 1 | geodb_ci_test_user | land_use | created_at | timestamp with time zone |
| 2 | geodb_ci_test_user | land_use | modified_at | timestamp with time zone |
| 3 | geodb_ci_test_user | land_use | geometry | USER-DEFINED |
| 4 | geodb_ci_test_user | land_use | raba_pid | double precision |
| 5 | geodb_ci_test_user | land_use | raba_id | double precision |
| 6 | geodb_ci_test_user | land_use | d_od | date |
| 7 | geodb_ci_test_user | land_use | test_prop | integer |
In [20]:
Copied!
geodb.drop_property('land_use', 'test_prop')
geodb.drop_property('land_use', 'test_prop')
Out[20]:
Properties ['test_prop'] dropped from geodb_ci_test_user_land_use
In [21]:
Copied!
geodb.get_properties('land_use')
geodb.get_properties('land_use')
Out[21]:
| database | table_name | column_name | data_type | |
|---|---|---|---|---|
| 0 | geodb_ci_test_user | land_use | id | integer |
| 1 | geodb_ci_test_user | land_use | created_at | timestamp with time zone |
| 2 | geodb_ci_test_user | land_use | modified_at | timestamp with time zone |
| 3 | geodb_ci_test_user | land_use | geometry | USER-DEFINED |
| 4 | geodb_ci_test_user | land_use | raba_pid | double precision |
| 5 | geodb_ci_test_user | land_use | raba_id | double precision |
| 6 | geodb_ci_test_user | land_use | d_od | date |
In [22]:
Copied!
geodb.add_properties('land_use', properties={'test1': 'integer', 'test2': 'date'})
geodb.add_properties('land_use', properties={'test1': 'integer', 'test2': 'date'})
Out[22]:
Properties added
In [23]:
Copied!
geodb.get_properties('land_use')
geodb.get_properties('land_use')
Out[23]:
| database | table_name | column_name | data_type | |
|---|---|---|---|---|
| 0 | geodb_ci_test_user | land_use | id | integer |
| 1 | geodb_ci_test_user | land_use | created_at | timestamp with time zone |
| 2 | geodb_ci_test_user | land_use | modified_at | timestamp with time zone |
| 3 | geodb_ci_test_user | land_use | geometry | USER-DEFINED |
| 4 | geodb_ci_test_user | land_use | raba_pid | double precision |
| 5 | geodb_ci_test_user | land_use | raba_id | double precision |
| 6 | geodb_ci_test_user | land_use | d_od | date |
| 7 | geodb_ci_test_user | land_use | test1 | integer |
| 8 | geodb_ci_test_user | land_use | test2 | date |
In [24]:
Copied!
geodb.drop_properties('land_use', properties=['test1', 'test2'])
geodb.drop_properties('land_use', properties=['test1', 'test2'])
Out[24]:
Properties ['test1', 'test2'] dropped from geodb_ci_test_user_land_use
In [8]:
Copied!
geodb.get_properties('land_use')
geodb.get_properties('land_use')
Out[8]:
| table_name | column_name | data_type | |
|---|---|---|---|
| 0 | geodb_admin_land_use | id | integer |
| 1 | geodb_admin_land_use | created_at | timestamp with time zone |
| 2 | geodb_admin_land_use | modified_at | timestamp with time zone |
| 3 | geodb_admin_land_use | geometry | USER-DEFINED |
| 4 | geodb_admin_land_use | raba_pid | double precision |
| 5 | geodb_admin_land_use | raba_id | double precision |
| 6 | geodb_admin_land_use | d_od | date |
| 7 | geodb_admin_land_use | testä_prop | integer |
In [25]:
Copied!
geodb.drop_collection('land_use')
geodb.drop_collection('land_use')
Out[25]:
Collection ['geodb_ci_test_user_land_use'] deleted
In [ ]:
Copied!