Merge branch 'main' of github.com:RelationalAI/rai-sdk-python into pv-override-auth0-audience

Author: Sameera Salameh

examples/delete_transaction.py examples/cancel_transaction.pyexamples/delete_transaction.py renamed to examples/cancel_transaction.py

@@ -12,7 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License
 
-"""Delete a transaction."""
 
 import json
 from argparse import ArgumentParser
@@ -24,7 +23,7 @@
 def run(id: str, profile: str):
     cfg = config.read(profile=profile)
     ctx = api.Context(**cfg)
-    rsp = api.delete_transaction(ctx, id)
+    rsp = api.cancel_transaction(ctx, id)
     print(json.dumps(rsp, indent=2))
 
 

examples/get_engine.py

@@ -21,7 +21,7 @@
 
 
 def run(engine: str, profile: str):
-    cfg = config.read()
+    cfg = config.read(profile=profile)
     ctx = api.Context(**cfg)
     rsp = api.get_engine(ctx, engine)
     print(json.dumps(rsp, indent=2))

examples/get_transaction_results.py

@@ -14,6 +14,7 @@
 
 """Fetch results for the given transaction."""
 
+import json
 from argparse import ArgumentParser
 from urllib.request import HTTPError
 from railib import api, config, show
@@ -23,8 +24,13 @@ def run(id: str, profile: str):
     cfg = config.read(profile=profile)
     ctx = api.Context(**cfg)
     rsp = api.get_transaction_results(ctx, id)
+    print("Results:")
     show.results(rsp, "multipart")
 
+    rsp = api.get_transaction_problems(ctx, id)
+    print("\nProblems:")
+    print(json.dumps(rsp, indent=2))
+
 
 if __name__ == "__main__":
     p = ArgumentParser()

examples/list_transactions.py

@@ -0,0 +1,38 @@
+# Copyright 2021-2022 RelationalAI, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License
+
+"""Fetch a list of transactions."""
+
+import json
+from argparse import ArgumentParser
+from urllib.request import HTTPError
+from railib import api, config, show
+
+
+def run(profile: str):
+    cfg = config.read(profile=profile)
+    ctx = api.Context(**cfg)
+    rsp = api.list_transactions(ctx)
+    print(json.dumps(rsp, indent=2))
+
+
+if __name__ == "__main__":
+    p = ArgumentParser()
+    p.add_argument("-p", "--profile", type=str,
+                   help="profile name", default="default")
+    args = p.parse_args()
+    try:
+        run(args.profile)
+    except HTTPError as e:
+        show.http_error(e)

examples/list_users.py

@@ -15,19 +15,23 @@
 """List all users."""
 
 import json
+from argparse import ArgumentParser
 from urllib.request import HTTPError
 from railib import api, config, show
 
 
-def run():
-    cfg = config.read()
+def run(profile: str):
+    cfg = config.read(profile=profile)
     ctx = api.Context(**cfg)
     rsp = api.list_users(ctx)
     print(json.dumps(rsp, indent=2))
 
 
 if __name__ == "__main__":
+    p = ArgumentParser()
+    p.add_argument("-p", "--profile", type=str, help="profile name", default="default")
+    args = p.parse_args()
     try:
-        run()
+        run(args.profile)
     except HTTPError as e:
         show.http_error(e)

examples/run examples/run-allexamples/run renamed to examples/run-all

@@ -2,9 +2,9 @@
 
 set -ex
 
-ENGINE=sdk-test-xs
 DATABASE=sdk-test
 DATABASE_CLONE=$DATABASE-clone
+ENGINE=sdk-test-xs
 
 # setup
 python3 ./delete_database.py $DATABASE_CLONE
@@ -13,17 +13,20 @@ python3 ./delete_engine.py $ENGINE
 
 # engines
 python3 ./create_engine.py $ENGINE --size=XS
+python3 ./get_engine.py $ENGINE
 python3 ./list_engines.py
 python3 ./list_engines.py --state=PROVISIONED
-python3 ./get_engine.py $ENGINE
+python3 ./list_engines.py --state=NONESENSE
 
 # databases
 python3 ./create_database.py $DATABASE
+python3 ./get_database.py $DATABASE
 python3 ./list_databases.py
 python3 ./list_databases.py --state=CREATED
-python3 ./get_database.py $DATABASE
-python3 ./list_models.py $DATABASE $ENGINE
+python3 ./list_databases.py --state=NONSENSE
 python3 ./list_edbs.py $DATABASE $ENGINE
+python3 ./list_models.py $DATABASE $ENGINE
+python3 ./get_model.py $DATABASE $ENGINE stdlib
 
 # run query
 QUERY="x, x^2, x^3, x^4 from x in {1; 2; 3; 4; 5}"
@@ -32,11 +35,12 @@ python3 ./run_query.py $DATABASE $ENGINE "$QUERY" --readonly
 python3 ./show_results.py $DATABASE $ENGINE
 python3 ./show_problems.py $DATABASE $ENGINE
 
-# install model
+# load model
 python3 ./install_model.py $DATABASE $ENGINE hello.rel
-python3 ./list_models.py $DATABASE $ENGINE
 python3 ./get_model.py $DATABASE $ENGINE hello
-python3 ./list_edbs.py $DATABASE $ENGINE
+python3 ./list_models.py $DATABASE $ENGINE
+python3 ./delete_model.py $DATABASE $ENGINE hello
+python3 ./list_models.py $DATABASE $ENGINE
 
 # load_csv
 python3 ./load_csv.py $DATABASE $ENGINE sample.csv -r sample_csv
@@ -53,12 +57,16 @@ python3 ./run_query.py $DATABASE $ENGINE sample_json
 python3 ./list_edbs.py $DATABASE $ENGINE
 
 # clone database
+python3 ./delete_database.py $DATABASE
+python3 ./create_database.py $DATABASE
+python3 ./load_json.py $DATABASE $ENGINE sample.json -r sample_json
+python3 ./install_model.py $DATABASE $ENGINE hello.rel
 python3 ./clone_database.py $DATABASE_CLONE $DATABASE
+python3 ./get_database.py $DATABASE_CLONE
 python3 ./list_databases.py
 python3 ./list_databases.py --state=CREATED
-python3 ./get_database.py $DATABASE_CLONE
-python3 ./list_models.py $DATABASE_CLONE $ENGINE
 python3 ./list_edbs.py $DATABASE_CLONE $ENGINE
+python3 ./list_models.py $DATABASE_CLONE $ENGINE
 python3 ./get_model.py $DATABASE_CLONE $ENGINE hello
 
 # delete model
@@ -86,7 +94,6 @@ python3 update_user.py $USERID --status=INACTIVE
 python3 update_user.py $USERID --status=ACTIVE
 python3 update_user.py $USERID --roles=admin --roles=user
 python3 update_user.py $USERID --status=INACTIVE --roles=user
-python3 update_user.py $USERID
 
 # cleanup
 python3 ./delete_database.py $DATABASE_CLONE

examples/run_query_async.py

@@ -11,6 +11,7 @@
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License
+
 from argparse import ArgumentParser
 from urllib.request import HTTPError
 from railib import api, config, show
@@ -20,7 +21,7 @@ def run(database: str, engine: str, command: str, readonly: bool, profile: str):
     cfg = config.read(profile=profile)
     ctx = api.Context(**cfg)
     rsp = api.query_async(ctx, database, engine, command, readonly=readonly)
-    show.results(rsp, "multipart" if isinstance(rsp, list) else "wire")
+    show.results(rsp)
 
 
 if __name__ == "__main__":

railib/api.py

@@ -71,7 +71,6 @@ class Permission(str, Enum):
     # transactions
     RUN_TRANSACTION = "run:transaction"
     READ_TRANSACTION = "read:transaction"
-    DELETE_TRANSACTION = "delete:transaction"
     # credits
     READ_CREDITS_USAGE = "read:credits_usage"
     # oauth clients
@@ -109,7 +108,6 @@ class Permission(str, Enum):
     "delete_database",
     "delete_engine",
     "delete_model",
-    "delete_transaction",
     "disable_user",
     "enable_user",
     "delete_oauth_client",
@@ -120,6 +118,7 @@ class Permission(str, Enum):
     "get_transaction",
     "get_transaction_metadata",
     "get_transaction_results",
+    "cancel_transaction",
     "get_user",
     "list_databases",
     "list_edbs",
@@ -130,6 +129,7 @@ class Permission(str, Enum):
     "load_csv",
     "update_user",
     "query",
+    "query_async",
 ]
 
 
@@ -163,7 +163,7 @@ def _get_resource(ctx: Context, path: str, key=None, **kwargs) -> dict:
 
 
 # Retrieve a generic collection of resources.
-def _list_collection(ctx, path: str, key=None, **kwargs):
+def _get_collection(ctx, path: str, key=None, **kwargs):
     rsp = rest.get(ctx, _mkurl(ctx, path), **kwargs)
     rsp = json.loads(rsp.read())
     return rsp[key] if key else rsp
@@ -248,12 +248,6 @@ def delete_engine(ctx: Context, engine: str) -> dict:
     return json.loads(rsp.read())
 
 
-def delete_transaction(ctx: Context, id: str) -> dict:
-    url = _mkurl(ctx, f"{PATH_TRANSACTIONS}/{id}")
-    rsp = rest.delete(ctx, url, None)
-    return json.loads(rsp.read())
-
-
 def delete_user(ctx: Context, id: str) -> dict:
     url = _mkurl(ctx, f"{PATH_USER}/{id}")
     rsp = rest.delete(ctx, url, None)
@@ -291,7 +285,15 @@ def get_transaction(ctx: Context, id: str) -> dict:
 
 
 def get_transaction_metadata(ctx: Context, id: str) -> dict:
-    return _get_resource(ctx, f"{PATH_TRANSACTIONS}/{id}/metadata")
+    return _get_collection(ctx, f"{PATH_TRANSACTIONS}/{id}/metadata")
+
+
+def list_transactions(ctx: Context) -> list:
+    return _get_collection(ctx, PATH_TRANSACTIONS, key="transactions")
+
+
+def get_transaction_problems(ctx: Context, id: str) -> dict:
+    return _get_collection(ctx, f"{PATH_TRANSACTIONS}/{id}/problems")
 
 
 def get_transaction_results(ctx: Context, id: str) -> list:
@@ -303,6 +305,11 @@ def get_transaction_results(ctx: Context, id: str) -> list:
     return _parse_multipart(content_type, rsp.read())
 
 
+def cancel_transaction(ctx: Context, id: str) -> dict:
+    rsp = rest.post(ctx, _mkurl(ctx, f"{PATH_TRANSACTIONS}/{id}/cancel"), {})
+    return json.loads(rsp.read())
+
+
 def get_user(ctx: Context, userid: str) -> dict:
     return _get_resource(ctx, f"{PATH_USER}/{userid}", name=userid)
 
@@ -311,22 +318,22 @@ def list_engines(ctx: Context, state=None) -> list:
     kwargs = {}
     if state is not None:
         kwargs["state"] = state
-    return _list_collection(ctx, PATH_ENGINE, key="computes", **kwargs)
+    return _get_collection(ctx, PATH_ENGINE, key="computes", **kwargs)
 
 
 def list_databases(ctx: Context, state=None) -> list:
     kwargs = {}
     if state is not None:
         kwargs["state"] = state
-    return _list_collection(ctx, PATH_DATABASE, key="databases", **kwargs)
+    return _get_collection(ctx, PATH_DATABASE, key="databases", **kwargs)
 
 
 def list_users(ctx: Context) -> list:
-    return _list_collection(ctx, PATH_USER, key="users")
+    return _get_collection(ctx, PATH_USER, key="users")
 
 
 def list_oauth_clients(ctx: Context) -> list:
-    return _list_collection(ctx, PATH_OAUTH_CLIENT, key="clients")
+    return _get_collection(ctx, PATH_OAUTH_CLIENT, key="clients")
 
 
 def update_user(ctx: Context, userid: str, status: str = None, roles=None):
@@ -340,9 +347,6 @@ def update_user(ctx: Context, userid: str, status: str = None, roles=None):
     return json.loads(rsp.read())
 
 
-#
-# Transaction endpoint
-#
 class Transaction(object):
     def __init__(self, database: str, engine: str, abort=False,
                  mode: Mode = Mode.OPEN, nowait_durable=False, readonly=False,
@@ -398,23 +402,15 @@ def run(self, ctx: Context, *args) -> dict:
         return json.loads(rsp.read())
 
 
-#
-# /transactions endpoint
-#
 class TransactionAsync(object):
-    def __init__(self, database: str, engine: str, command: str, nowait_durable=False, readonly=False,
-                 inputs: dict = None):
+    def __init__(self, database: str, engine: str, nowait_durable=False, readonly=False):
         self.database = database
         self.engine = engine
-        self.command = command
         self.nowait_durable = nowait_durable
         self.readonly = readonly
-        self.inputs = inputs
 
     @property
     def data(self):
-        inputs = self.inputs or {}
-        inputs = [_query_action_input(k, v) for k, v in inputs.items()]
         result = {
             "dbname": self.database,
             "nowait_durable": self.nowait_durable,
@@ -423,16 +419,18 @@ def data(self):
         }
         if self.engine is not None:
             result["engine_name"] = self.engine
-        result["query"] = self.command
-        result["inputs"] = inputs
         return result
 
-    def run(self, ctx: Context) -> Union[dict, list]:
+    def run(self, ctx: Context, command: str, inputs: dict = None) -> Union[dict, list]:
         data = self.data
-        url = _mkurl(ctx, PATH_TRANSACTIONS)
-        rsp = rest.post(ctx, url, data)
+        data["query"] = command
+        if not inputs is None:
+            inputs = [_query_action_input(k, v) for k, v in inputs.items()]
+            data["v1_inputs"] = inputs
+        rsp = rest.post(ctx, _mkurl(ctx, PATH_TRANSACTIONS), data)
         content_type = rsp.headers.get('content-type', None)
         content = rsp.read()
+        # todo: response model should be based on status code (200 v. 201)
         # async mode
         if content_type.lower() == "application/json":
             return json.loads(content)
@@ -660,8 +658,8 @@ def query(ctx: Context, database: str, engine: str, command: str,
 
 def query_async(ctx: Context, database: str, engine: str, command: str,
                 readonly: bool = True, inputs: dict = None) -> Union[dict, list]:
-    tx = TransactionAsync(database, engine, command, readonly=readonly, inputs=inputs)
-    return tx.run(ctx)
+    tx = TransactionAsync(database, engine, readonly=readonly)
+    return tx.run(ctx, command, inputs=inputs)
 
 
 create_compute = create_engine  # deprecated, use create_engine

railib/credentials.py

@@ -46,7 +46,7 @@ def __init__(self, access_token: str, expires_in: int):
         self.created_on = round(time.time())
 
     def is_expired(self):
-        return time.time() - self.created_on >= self.expires_in
+        return time.time() - self.created_on >= self.expires_in - 5 # anticipate token expiration by 5 seconds
 
 
 # Represents OAuth client credentials.