key value store

changes/pr4499.yaml

@@ -0,0 +1,2 @@
+feature:
+  - "Key Value Store - [#4499](https://github.com/PrefectHQ/prefect/pull/4499)"

docs/.vuepress/config.js

@@ -111,6 +111,11 @@ module.exports = {
           collapsable: true,
           children: ['triggers']
         },
+        {
+          title: 'prefect.backend',
+          collapsable: true,
+          children: getChildren('docs/api/latest', 'backend')
+        },
         {
           title: 'prefect.client',
           collapsable: true,
@@ -199,6 +204,7 @@ module.exports = {
             'concepts/projects',
             'concepts/flows',
             'concepts/flow_runs',
+            'concepts/kv_store',
             'concepts/secrets',
             'concepts/api_keys',
             'concepts/roles',

docs/orchestration/concepts/kv_store.md

@@ -0,0 +1,123 @@
+# KV Store <Badge text="Cloud"/>
+
+Key Value Store is a managed metadata database within Prefect Cloud.
+
+**Keys** are strings. **Values** are json blobs.
+
+The number of key value pairs allowed is limited by license, starting with 50 pairs on the Free tier. Values are limited to 1 MB in size.
+
+Key value pairs can be configured via the Prefect CLI, Python client, API, and UI.
+
+## UI
+
+You can view, update, and delete key value pairs on the [KV Store page](https://cloud.prefect.io/team/kv) of the UI.  
+
+## Setting Key Value Pairs
+
+Setting a key value pair will overwrite the existing value if the key exists.
+
+:::: tabs
+::: tab Prefect library
+```python
+from prefect.backend import set_key_value
+key_value_uuid = set_key_value(key="foo", value="bar")
+```
+:::
+::: tab CLI
+```bash
+$ prefect kv set foo bar
+Key value pair set successfully
+```
+:::
+::: tab GraphQL API
+```graphql
+mutation {
+  set_key_value(input: { key : "foo", value: "\"bar\"" }) {
+    id
+  }
+}
+```
+:::
+::::
+
+## Getting the Value of a Key
+
+:::: tabs
+::: tab Prefect library
+```python
+from prefect.backend import get_key_value
+value = get_key_value(key="foo")
+```
+:::
+::: tab CLI
+```bash
+$ prefect kv get foo
+Key foo has value bar
+```
+:::
+::: tab GraphQL API
+```graphql
+query {
+  key_value (where: {key: {_eq: "foo"}}) {
+    value
+  }
+}
+```
+:::
+::::
+
+## Deleting Key Value Pairs
+
+:::: tabs
+::: tab Prefect library
+```python
+from prefect.backend import delete_key
+success = delete_key(key="foo")
+```
+:::
+::: tab CLI
+```bash
+$ prefect kv delete foo
+Key foo has been deleted
+```
+:::
+::: tab GraphQL API
+```graphql
+mutation {
+  delete_key_value(input: { key_value_id : "35c8cabb-ab30-41c2-b464-6c2ed39f0d5b" }) {
+    success
+  }
+}
+```
+:::
+::::
+
+## Listing Keys
+
+:::: tabs
+::: tab Prefect library
+```python
+from prefect.backend import list_keys
+my_keys = list_keys()
+```
+:::
+::: tab CLI
+```bash
+$ prefect kv list
+foo
+my-other-key
+another-key
+```
+:::
+::: tab GraphQL API
+```graphql
+query {
+  key_value {
+    id
+    key
+    value
+  }
+}
+```
+:::
+::::

docs/outline.toml

@@ -18,6 +18,11 @@ functions = [
     "some_successful",
 ]
 
+[pages.backend.kv_store]
+title = "KV Store"
+module = "prefect.backend.kv_store"
+functions = ["set_key_value", "get_key_value", "delete_key", "list_keys"]
+
 [pages.client.client]
 title = "Client"
 module = "prefect.client"
@@ -68,6 +73,11 @@ title = "build"
 module = "prefect.cli.build_register"
 commands = ["build"]
 
+[pages.cli.kv_store]
+title = "kv_store"
+module = "prefect.cli.kv_store"
+commands = ["set_command", "get_command", "delete_command", "list_command"]
+
 [pages.cli.run]
 title = "run"
 module = "prefect.cli.run"

src/prefect/backend/__init__.py

@@ -0,0 +1 @@
+from prefect.backend.kv_store import set_key_value, get_key_value, delete_key, list_keys

src/prefect/backend/kv_store.py

@@ -0,0 +1,121 @@
+from typing import Any, List
+
+import prefect
+from prefect.utilities.graphql import with_args
+from prefect.client import Client
+from prefect.utilities.exceptions import ClientError
+
+
+def set_key_value(key: str, value: Any) -> str:
+    """
+    Set key value pair, overwriting values for existing key
+
+    Args:
+        - key (str): the name of the key
+        - value (Any): A json compatible value
+
+    Returns:
+        - id (str): the id of the key value pair
+
+    Raises:
+        - ClientError: if using Prefect Server instead of Cloud
+    """
+    if prefect.config.backend != "cloud":
+        raise ClientError("Key Value operations are Cloud only")
+
+    mutation = {
+        "mutation($input: set_key_value_input!)": {
+            "set_key_value(input: $input)": {"id"}
+        }
+    }
+
+    client = Client()
+    result = client.graphql(
+        query=mutation, variables=dict(input=dict(key=key, value=value))
+    )
+
+    return result.data.set_key_value.id
+
+
+def get_key_value(key: str) -> Any:
+    """
+    Get the value for a key
+
+    Args:
+        - key (str): the name of the key
+
+    Returns:
+        - value (Any): A json compatible value
+
+    Raises:
+        - ValueError: if the specified key does not exist
+        - ClientError: if using Prefect Server instead of Cloud
+    """
+    if prefect.config.backend != "cloud":
+        raise ClientError("Key Value operations are Cloud only")
+
+    query = {
+        "query": {with_args("key_value", {"where": {"key": {"_eq": key}}}): {"value"}}
+    }
+    client = Client()
+    result = client.graphql(query)  # type: Any
+    if len(result.data.key_value) == 0:
+        raise ValueError(f"No value found for key: {key}")
+    return result.data.key_value[0].value
+
+
+def delete_key(key: str) -> bool:
+    """
+    Delete a key value pair
+
+    Args:
+        - key (str): the name of the key
+
+    Returns:
+        - success (bool): Whether or not deleting the key succeeded
+
+    Raises:
+        - ValueError: if the specified key does not exist
+        - ClientError: if using Prefect Server instead of Cloud
+    """
+    if prefect.config.backend != "cloud":
+        raise ClientError("Key Value operations are Cloud only")
+
+    query = {
+        "query": {with_args("key_value", {"where": {"key": {"_eq": key}}}): {"id"}}
+    }
+    mutation = {
+        "mutation($input: delete_key_value_input!)": {
+            "delete_key_value(input: $input)": {"success"}
+        }
+    }
+
+    client = Client()
+    key_value_id_query = client.graphql(query=query)
+    if len(key_value_id_query.data.key_value) == 0:
+        raise ValueError(f"No key {key} found to delete")
+    result = client.graphql(
+        query=mutation,
+        variables=dict(
+            input=dict(key_value_id=key_value_id_query.data.key_value[0].id)
+        ),
+    )
+
+    return result.data.delete_key_value.success
+
+
+def list_keys() -> List[str]:
+    """
+    List all keys
+
+    Returns:
+        - keys (list): A list of keys
+
+    Raises:
+        - ClientError: if using Prefect Server instead of Cloud
+    """
+    if prefect.config.backend != "cloud":
+        raise ClientError("Key Value operations are Cloud only")
+    client = Client()
+    result = client.graphql({"query": {"key_value": {"key"}}})  # type: ignore
+    return sorted([res["key"] for res in result.data.key_value])

src/prefect/cli/__init__.py

@@ -17,6 +17,7 @@
 from .server import server as _server
 from .heartbeat import heartbeat as _heartbeat
 from .build_register import register as _register, build as _build
+from .kv_store import kv as _kv
 
 
 CONTEXT_SETTINGS = dict(help_option_names=["-h", "--help"])
@@ -73,6 +74,7 @@ def cli():
 cli.add_command(_heartbeat)
 cli.add_command(_register)
 cli.add_command(_build)
+cli.add_command(_kv)
 
 
 # Miscellaneous Commands