Share geoDB Collections¶

This notebook demonstrates how to (un)publish data collections in the xcube geoDB.

In [1]:

Copied!

from xcube_geodb.core.geodb import GeoDBClient
from xcube_geodb.core.geodb import GeoDBClient

Install xcube geoDB with command:

conda install xcube_geodb -c conda-forge

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")

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 [4]:

Copied!

geodb.whoami
geodb.whoami

Out[4]:

'geodb_ci_test_user'

Create Collection¶

In [6]:

Copied!





import geopandas

# 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)

gdf = geopandas.read_file('data/sample/land_use.shp')
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.
import geopandas

# 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)

gdf = geopandas.read_file('data/sample/land_use.shp')
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.

Processing rows from 0 to 100

Out[6]:

100 rows inserted into land_use

Publish a Collection to the World¶

In [7]:

Copied!

geodb.list_my_grants()
geodb.list_my_grants()

Out[7]:

	Grants
0	No Grants

Please change the second positional kwargs to the geodb user you want to grant access to, if you are on EDC, go ahead and use 'geodb_test5' user:

In [8]:

Copied!

geodb.grant_access_to_collection("land_use", "geodb_admin")
geodb.grant_access_to_collection("land_use", "geodb_admin")

Out[8]:

Access granted on land_use to geodb_admin

In [9]:

Copied!

geodb.list_my_grants()
geodb.list_my_grants()

Out[9]:

	database	table_name	grantee	privileges
0	geodb_ci_test_user	land_use	geodb_admin	SELECT

Accessing the Collection as a different User¶

Let's access the collection as a different user (a test user in this case), whose credentials were exported as an environment variable. You should now see a land_use collection.

In [10]:

Copied!

import os
import os

In [11]:

Copied!

test_client_id = os.environ.get("TEST_CLIENT_ID")
test_client_secret = os.environ.get("TEST_CLIENT_SECRET")
test_client_geodb_api_server_url=os.environ.get("TEST_GEODB_API_SERVER_URL")
test_client_id = os.environ.get("TEST_CLIENT_ID")
test_client_secret = os.environ.get("TEST_CLIENT_SECRET")
test_client_geodb_api_server_url=os.environ.get("TEST_GEODB_API_SERVER_URL")

In [12]:

Copied!

geodb = GeoDBClient(client_id=test_client_id, client_secret=test_client_secret, auth_mode="client-credentials", server_url=test_client_geodb_api_server_url)
geodb.whoami
geodb = GeoDBClient(client_id=test_client_id, client_secret=test_client_secret, auth_mode="client-credentials", server_url=test_client_geodb_api_server_url)
geodb.whoami

Out[12]:

'geodb_test5'

In [13]:

Copied!

geodb.get_my_collections()
geodb.get_my_collections()

Out[13]:

	owner	database	table_name
0	geodb_8c2d3fbe-f7a9-4492-8068-121e47e61a4f	test_db	test_default_db
1	geodb_8c2d3fbe-f7a9-4492-8068-121e47e61a4f	test_db	test_deleting
2	geodb_9bfgsdfg-453f-445b-a459	geodb_9bfgsdfg-453f-445b-a459	land_use

Revoke access¶

Let's go back to the original user.

In [14]:

Copied!

geodb = GeoDBClient()
geodb.whoami
geodb = GeoDBClient()
geodb.whoami

Out[14]:

'geodb_ci_test_user'

In [15]:

Copied!

geodb.list_my_grants()
geodb.list_my_grants()

Out[15]:

	database	table_name	grantee	privileges
0	geodb_ci_test_user	land_use	geodb_admin	SELECT

In [16]:

Copied!

geodb.revoke_access_from_collection("land_use", 'geodb_admin')
geodb.revoke_access_from_collection("land_use", 'geodb_admin')

Out[16]:

Access revoked from geodb_ci_test_user on land_use

In [17]:

Copied!

geodb.list_my_grants()
geodb.list_my_grants()

Out[17]:

	Grants
0	No Grants

Finally going back to the initial user and deleting the collection:¶