gsctl 0.29.0a20250114__py2.py3-none-any.whl

graphscope/gsctl/impl/alert.py

@@ -0,0 +1,135 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright 2024 Alibaba Group Holding Limited. All Rights Reserved.
+#
+# 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.
+#
+
+from typing import List
+
+import graphscope.flex.rest
+from graphscope.flex.rest import CreateAlertReceiverRequest
+from graphscope.flex.rest import CreateAlertRuleRequest
+from graphscope.flex.rest import GetAlertMessageResponse
+from graphscope.flex.rest import GetAlertReceiverResponse
+from graphscope.flex.rest import GetAlertRuleResponse
+from graphscope.flex.rest import UpdateAlertMessageStatusRequest
+from graphscope.gsctl.config import get_current_context
+
+
+def list_alert_rules() -> List[GetAlertRuleResponse]:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.AlertApi(api_client)
+        return api_instance.list_alert_rules()
+
+
+def update_alert_rule_by_id(rule_id: str, rule: dict) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.AlertApi(api_client)
+        return api_instance.update_alert_rule_by_id(
+            rule_id, CreateAlertRuleRequest.from_dict(rule)
+        )
+
+
+def delete_alert_rule_by_id(rule_id: str) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.AlertApi(api_client)
+        return api_instance.delete_alert_rule_by_id(rule_id)
+
+
+def list_alert_messages(
+    alert_type=None,
+    status=None,
+    severity=None,
+    start_time=None,
+    end_time=None,
+    limit=None,
+) -> List[GetAlertMessageResponse]:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.AlertApi(api_client)
+        return api_instance.list_alert_messages(
+            alert_type, status, severity, start_time, end_time, limit
+        )
+
+
+def update_alert_message_in_batch(message_status: dict) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.AlertApi(api_client)
+        return api_instance.update_alert_message_in_batch(
+            UpdateAlertMessageStatusRequest.from_dict(message_status)
+        )
+
+
+def delete_alert_message_in_batch(message_ids: str) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.AlertApi(api_client)
+        return api_instance.delete_alert_message_in_batch(message_ids)
+
+
+def create_alert_receiver(receiver: dict) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.AlertApi(api_client)
+        return api_instance.create_alert_receiver(
+            CreateAlertReceiverRequest.from_dict(receiver)
+        )
+
+
+def update_alert_receiver_by_id(receiver_id: str, receiver: dict) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.AlertApi(api_client)
+        return api_instance.update_alert_receiver_by_id(
+            receiver_id, CreateAlertReceiverRequest.from_dict(receiver)
+        )
+
+
+def list_alert_receivers() -> List[GetAlertReceiverResponse]:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.AlertApi(api_client)
+        return api_instance.list_alert_receivers()
+
+
+def delete_alert_receiver_by_id(receiver_id: str) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.AlertApi(api_client)
+        return api_instance.delete_alert_receiver_by_id(receiver_id)

graphscope/gsctl/impl/common.py

@@ -0,0 +1,53 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright 2024 Alibaba Group Holding Limited. All Rights Reserved.
+#
+# 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.
+#
+
+from typing import Union
+
+import graphscope.flex.rest
+from graphscope.flex.rest import RunningDeploymentInfo
+from graphscope.gsctl.config import Context
+from graphscope.gsctl.config import load_gs_config
+
+
+def connect_coordinator(coordinator_endpoint: str) -> RunningDeploymentInfo:
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.DeploymentApi(api_client)
+        deployment_info = api_instance.get_deployment_info()
+        # coordinator connected, set the context
+        flex = {
+            "engine": deployment_info.engine,
+            "storage": deployment_info.storage,
+            "frontend": deployment_info.frontend,
+        }
+        context = Context(
+            flex=flex,
+            coordinator_endpoint=coordinator_endpoint,
+        )
+        config = load_gs_config()
+        config.set_and_write(context)
+        return deployment_info
+
+
+def disconnect_coordinator() -> Union[None, Context]:
+    config = load_gs_config()
+    current_context = config.current_context()
+    if current_context is not None:
+        config.remove_and_write(current_context)
+    return current_context

graphscope/gsctl/impl/datasource.py

@@ -0,0 +1,80 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright 2024 Alibaba Group Holding Limited. All Rights Reserved.
+#
+# 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.
+#
+
+import itertools
+import os
+
+import graphscope.flex.rest
+from graphscope.flex.rest import SchemaMapping
+from graphscope.gsctl.config import get_current_context
+from graphscope.gsctl.impl.utils import upload_file
+
+
+def bind_datasource_in_batch(graph_identifier: str, datasource: dict) -> str:
+    # upload files
+    for mapping in itertools.chain(
+        datasource["vertex_mappings"], datasource["edge_mappings"]
+    ):
+        for index, location in enumerate(mapping["inputs"]):
+            # path begin with "@" represents the local file
+            if location.startswith("@"):
+                location = location[1:]
+                mapping["inputs"][index] = upload_file(location)
+    # bind data source
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.DataSourceApi(api_client)
+        return api_instance.bind_datasource_in_batch(
+            graph_identifier, SchemaMapping.from_dict(datasource)
+        )
+
+
+def get_datasource_by_id(graph_identifier: str) -> SchemaMapping:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.DataSourceApi(api_client)
+        return api_instance.get_datasource_by_id(graph_identifier)
+
+
+def unbind_vertex_datasource(graph_identifier: str, vertex_type: str) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.DataSourceApi(api_client)
+        return api_instance.unbind_vertex_datasource(graph_identifier, vertex_type)
+
+
+def unbind_edge_datasource(
+    graph_identifier: str,
+    vertex_type: str,
+    source_vertex_type: str,
+    destination_vertex_type: str,
+) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.DataSourceApi(api_client)
+        return api_instance.unbind_edge_datasource(
+            graph_identifier, vertex_type, source_vertex_type, destination_vertex_type
+        )

graphscope/gsctl/impl/deployment.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright 2024 Alibaba Group Holding Limited. All Rights Reserved.
+#
+# 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.
+#
+
+import graphscope.flex.rest
+from graphscope.flex.rest import GetPodLogResponse
+from graphscope.flex.rest import GetResourceUsageResponse
+from graphscope.flex.rest import GetStorageUsageResponse
+from graphscope.flex.rest import RunningDeploymentStatus
+from graphscope.gsctl.config import get_current_context
+
+
+def get_deployment_status() -> RunningDeploymentStatus:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.DeploymentApi(api_client)
+        return api_instance.get_deployment_status()
+
+
+def get_deployment_resource_usage() -> GetResourceUsageResponse:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.DeploymentApi(api_client)
+        return api_instance.get_deployment_resource_usage()
+
+
+def get_storage_usage() -> GetStorageUsageResponse:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.DeploymentApi(api_client)
+        return api_instance.get_storage_usage()
+
+
+def get_deployment_pod_log(
+    pod_name: str, component: str, from_cache: bool
+) -> GetPodLogResponse:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.DeploymentApi(api_client)
+        return api_instance.get_deployment_pod_log(pod_name, component, from_cache)

graphscope/gsctl/impl/graph.py

@@ -0,0 +1,150 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright 2024 Alibaba Group Holding Limited. All Rights Reserved.
+#
+# 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.
+#
+
+from typing import List
+
+import graphscope.flex.rest
+from graphscope.flex.rest import CreateEdgeType
+from graphscope.flex.rest import CreateGraphRequest
+from graphscope.flex.rest import CreateGraphSchemaRequest
+from graphscope.flex.rest import CreateVertexType
+from graphscope.flex.rest import GetGraphResponse
+from graphscope.gsctl.config import get_current_context
+
+
+def import_schema(graph_identifier: str, schema: dict) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.GraphApi(api_client)
+        return api_instance.import_schema_by_id(
+            graph_identifier, CreateGraphSchemaRequest.from_dict(schema)
+        )
+
+
+def create_vertex_type(graph_identifier: str, vertex_type: dict) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.GraphApi(api_client)
+        return api_instance.create_vertex_type(
+            graph_identifier, CreateVertexType.from_dict(vertex_type)
+        )
+
+
+def delete_vertex_type_by_name(graph_identifier: str, vertex_type: str) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.GraphApi(api_client)
+        return api_instance.delete_vertex_type_by_name(graph_identifier, vertex_type)
+
+
+def create_edge_type(graph_identifier: str, edge_type: dict) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.GraphApi(api_client)
+        return api_instance.create_edge_type(
+            graph_identifier, CreateEdgeType.from_dict(edge_type)
+        )
+
+
+def delete_edge_type_by_name(
+    graph_identifier: str,
+    edge_type: str,
+    source_vertex_type: str,
+    destination_vertex_type: str,
+) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.GraphApi(api_client)
+        return api_instance.delete_edge_type_by_name(
+            graph_identifier, edge_type, source_vertex_type, destination_vertex_type
+        )
+
+
+def list_graphs() -> List[GetGraphResponse]:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.GraphApi(api_client)
+        graphs = api_instance.list_graphs()
+        return graphs
+
+
+def get_graph_by_id(graph_identifier: str) -> GetGraphResponse:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.GraphApi(api_client)
+        return api_instance.get_graph_by_id(graph_identifier)
+
+
+def create_graph(graph: dict) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.GraphApi(api_client)
+        response = api_instance.create_graph(CreateGraphRequest.from_dict(graph))
+        return response.graph_id
+
+
+def delete_graph_by_id(graph_identifier: str) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.GraphApi(api_client)
+        return api_instance.delete_graph_by_id(graph_identifier)
+
+
+def get_graph_id_by_name(name_or_id: str):
+    graphs = list_graphs()
+    id_candidate = []
+    for g in graphs:
+        if name_or_id == g.id:
+            return name_or_id
+        if name_or_id == g.name:
+            id_candidate.append(g.id)
+    if not id_candidate:
+        raise RuntimeError(
+            f"Graph '{name_or_id}' not exists, see graph information with `ls` command."
+        )
+    if len(id_candidate) > 1:
+        raise RuntimeError(
+            f"Found multiple id candidates {id_candidate} for graph {name_or_id}, please choose one."
+        )
+    return id_candidate[0]
+
+
+def get_graph_name_by_id(graph_identifier: str):
+    graphs = list_graphs()
+    for g in graphs:
+        if g.id == graph_identifier:
+            return g.name
+    return graph_identifier

graphscope/gsctl/impl/job.py

@@ -0,0 +1,63 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright 2024 Alibaba Group Holding Limited. All Rights Reserved.
+#
+# 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.
+#
+
+from typing import List
+
+import graphscope.flex.rest
+from graphscope.flex.rest import DataloadingJobConfig
+from graphscope.flex.rest import JobStatus
+from graphscope.gsctl.config import get_current_context
+
+
+def submit_dataloading_job(graph_identifier: str, config: dict) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.JobApi(api_client)
+        response = api_instance.submit_dataloading_job(
+            graph_identifier, DataloadingJobConfig.from_dict(config)
+        )
+        return response.job_id
+
+
+def list_jobs() -> List[JobStatus]:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.JobApi(api_client)
+        return api_instance.list_jobs()
+
+
+def delete_job_by_id(job_identifier: str, delete_scheduler=False) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.JobApi(api_client)
+        return api_instance.delete_job_by_id(job_identifier, delete_scheduler)
+
+
+def get_job_by_id(job_identifier: str) -> JobStatus:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.JobApi(api_client)
+        return api_instance.get_job_by_id(job_identifier)

graphscope/gsctl/impl/service.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright 2024 Alibaba Group Holding Limited. All Rights Reserved.
+#
+# 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.
+#
+
+from typing import List
+
+import graphscope.flex.rest
+from graphscope.flex.rest import ServiceStatus
+from graphscope.flex.rest import StartServiceRequest
+from graphscope.gsctl.config import get_current_context
+
+
+def list_service_status() -> List[ServiceStatus]:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.ServiceApi(api_client)
+        return api_instance.list_service_status()
+
+
+def start_service(graph_identifier: str) -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.ServiceApi(api_client)
+        return api_instance.start_service(
+            StartServiceRequest.from_dict({"graph_id": graph_identifier})
+        )
+
+
+def stop_service() -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.ServiceApi(api_client)
+        return api_instance.stop_service()
+
+
+def restart_service() -> str:
+    context = get_current_context()
+    with graphscope.flex.rest.ApiClient(
+        graphscope.flex.rest.Configuration(context.coordinator_endpoint)
+    ) as api_client:
+        api_instance = graphscope.flex.rest.ServiceApi(api_client)
+        return api_instance.restart_service()