gsctl 0.29.0a20250114__py2.py3-none-any.whl

graphscope/gsctl/commands/interactive/graph.py

@@ -0,0 +1,259 @@
+#!/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 click
+import yaml
+
+from graphscope.gsctl.config import get_current_context
+from graphscope.gsctl.impl import create_stored_procedure
+from graphscope.gsctl.impl import delete_stored_procedure_by_id
+from graphscope.gsctl.impl import get_datasource_by_id
+from graphscope.gsctl.impl import get_graph_name_by_id
+from graphscope.gsctl.impl import list_graphs
+from graphscope.gsctl.impl import list_service_status
+from graphscope.gsctl.impl import list_stored_procedures
+from graphscope.gsctl.impl import restart_service
+from graphscope.gsctl.impl import start_service
+from graphscope.gsctl.impl import stop_service
+from graphscope.gsctl.impl import switch_context
+from graphscope.gsctl.utils import TreeDisplay
+from graphscope.gsctl.utils import err
+from graphscope.gsctl.utils import info
+from graphscope.gsctl.utils import is_valid_file_path
+from graphscope.gsctl.utils import read_yaml_file
+from graphscope.gsctl.utils import succ
+from graphscope.gsctl.utils import terminal_display
+
+
+@click.group()
+def cli():
+    pass
+
+
+@cli.group()
+def create():
+    """Create stored procedure from file"""
+    pass
+
+
+@cli.group()
+def delete():
+    """Delete stored procedure by id"""
+    pass
+
+
+@cli.group()
+def desc():
+    """Show stored procedure's details by id"""
+    pass
+
+
+@cli.group()
+def service():
+    """Start, stop, and restart the database service"""
+    pass
+
+
+@cli.group()
+def use():
+    """Switch back to the global scope"""
+    pass
+
+
+@cli.command()
+def ls():  # noqa: F811
+    """Display schema and stored procedure information"""
+    tree = TreeDisplay()
+    # context
+    current_context = get_current_context()
+    try:
+        graphs = list_graphs()
+        using_graph = None
+        for g in graphs:
+            if g.id == current_context.context:
+                using_graph = g
+                break
+        # schema
+        tree.create_graph_node(using_graph)
+        # data source mapping
+        datasource_mapping = get_datasource_by_id(using_graph.id)
+        tree.create_datasource_mapping_node(using_graph, datasource_mapping)
+        # stored procedure
+        stored_procedures = list_stored_procedures(using_graph.id)
+        tree.create_stored_procedure_node(using_graph, stored_procedures)
+    except Exception as e:
+        err(f"Failed to display graph information: {str(e)}")
+    else:
+        tree.show(graph_identifier=current_context.context)
+
+
+@create.command()
+@click.option(
+    "-f",
+    "--filename",
+    required=True,
+    help="Path of yaml file",
+)
+def storedproc(filename):
+    """Create a stored procedure from file"""
+    if not is_valid_file_path(filename):
+        err(f"Invalid file: {filename}")
+        return
+    current_context = get_current_context()
+    graph_identifier = current_context.context
+    try:
+        stored_procedure = read_yaml_file(filename)
+        create_stored_procedure(graph_identifier, stored_procedure)
+    except Exception as e:
+        err(f"Failed to create stored procedure: {str(e)}")
+    else:
+        succ(f"Create stored procedure {stored_procedure['name']} successfully.")
+
+
+@delete.command()
+@click.argument("identifier", required=True)
+def storedproc(identifier):  # noqa: F811
+    """Delete a stored procedure, see identifier with `ls` command"""
+    current_context = get_current_context()
+    graph_identifier = current_context.context
+    try:
+        if click.confirm("Do you want to continue?"):
+            delete_stored_procedure_by_id(graph_identifier, identifier)
+            succ(f"Delete stored procedure {identifier} successfully.")
+    except Exception as e:
+        err(f"Failed to delete stored procedure: {str(e)}")
+
+
+@desc.command()
+@click.argument("identifier", required=True)
+def storedproc(identifier):  # noqa: F811
+    """Show details of stored procedure, see identifier with `ls` command"""
+    current_context = get_current_context()
+    graph_id = current_context.context
+    try:
+        stored_procedures = list_stored_procedures(graph_id)
+    except Exception as e:
+        err(f"Failed to list stored procedures: {str(e)}")
+    else:
+        if not stored_procedures:
+            info(f"No stored procedures found on {graph_id}.")
+            return
+        specific_stored_procedure_exist = False
+        for stored_procedure in stored_procedures:
+            if identifier == stored_procedure.id:
+                info(yaml.dump(stored_procedure.to_dict()))
+                specific_stored_procedure_exist = True
+                break
+        if not specific_stored_procedure_exist:
+            err(f"Stored Procedure {identifier} not found on {graph_id}.")
+
+
+@service.command
+def stop():  # noqa: F811
+    """Stop current database service"""
+    try:
+        stop_service()
+    except Exception as e:
+        err(f"Failed to stop service: {str(e)}")
+    else:
+        succ("Service stopped.")
+
+
+@service.command
+def start():  # noqa: F811
+    """Start current database service"""
+    try:
+        current_context = get_current_context()
+        graph_identifier = current_context.context
+
+        status = list_service_status()
+        for s in status:
+            if s.graph_id == graph_identifier:
+                if s.status != "Running":
+                    info(f"Starting service on graph {graph_identifier}...")
+                    start_service(graph_identifier)
+                    succ("Service restarted.")
+                else:
+                    info("Service is running...")
+    except Exception as e:
+        err(f"Failed to start service: {str(e)}")
+
+
+@service.command
+def restart():  # noqa: F811
+    """Start current database service"""
+    try:
+        restart_service()
+    except Exception as e:
+        err(f"Failed to restart service: {str(e)}")
+    else:
+        succ("Service restarted.")
+
+
+@service.command
+def status():  # noqa: F811
+    """Display current service status"""
+
+    def _construct_and_display_data(status):
+        current_context = get_current_context()
+        graph_identifier = current_context.context
+        graph_name = current_context.graph_name
+
+        head = [
+            "STATUS",
+            "SERVING_GRAPH(IDENTIFIER)",
+            "CYPHER_ENDPOINT",
+            "HQPS_ENDPOINT",
+            "GREMLIN_ENDPOINT",
+        ]
+        data = [head]
+        for s in status:
+            if s.graph_id == graph_identifier:
+                if s.status == "Stopped":
+                    data.append(
+                        [s.status, f"{graph_name}(id={s.graph_id})", "-", "-", "-"]
+                    )
+                else:
+                    data.append(
+                        [
+                            s.status,
+                            f"{graph_name}(id={s.graph_id})",
+                            s.sdk_endpoints.cypher,
+                            s.sdk_endpoints.hqps,
+                            s.sdk_endpoints.gremlin,
+                        ]
+                    )
+        terminal_display(data)
+
+    try:
+        status = list_service_status()
+    except Exception as e:
+        err(f"Failed to list service status: {str(e)}")
+    else:
+        _construct_and_display_data(status)
+
+
+@use.command(name="GLOBAL")
+def _global():
+    """Switch back to the global scope"""
+    switch_context("global")
+    click.secho("Using GLOBAL", fg="green")
+
+
+if __name__ == "__main__":
+    cli()

graphscope/gsctl/config.py

@@ -0,0 +1,221 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+#
+# Copyright 2023 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.
+#
+
+"""Global configuration"""
+
+import os
+import random
+import time
+from string import ascii_letters
+
+from graphscope.gsctl.utils import read_yaml_file
+from graphscope.gsctl.utils import write_yaml_file
+
+GS_CONFIG_DEFAULT_LOCATION = os.environ.get("GSCONFIG", os.path.expanduser("~/.gsctl"))
+
+logo = """
+    ______                 __   _____
+   / ____/________ _____  / /_ / ___/_________  ____  ___
+  / / __/ ___/ __ `/ __ \/ __ \\\__ \/ ___/ __ \/ __ \/ _ \\
+ / /_/ / /  / /_/ / /_/ / / / /__/ / /__/ /_/ / /_/ /  __/
+ \____/_/   \__,_/ .___/_/ /_/____/\___/\____/ .___/\___/
+                /_/                         /_/
+"""  # noqa: W605
+
+
+class Context(object):
+    def __init__(
+        self,
+        coordinator_endpoint,
+        flex,
+        name=None,
+        timestamp=time.time(),
+        context="global",
+        graph_name=None,
+    ):
+        if name is None:
+            name = "context_" + "".join(random.choices(ascii_letters, k=8))
+
+        self.name = name
+        self.flex = flex
+        self.coordinator_endpoint = coordinator_endpoint
+        # switch to specific graph after `using graph`
+        self.context = context
+        self.graph_name = graph_name
+        self.timestamp = timestamp
+
+    def switch_context(self, context: str):
+        self.context = context
+        if self.context == "global":
+            self.graph_name = None
+
+    def set_graph_name(self, graph_name: str):
+        self.graph_name = graph_name
+
+    def to_dict(self) -> dict:
+        return {
+            "name": self.name,
+            "graph_name": str(self.graph_name),
+            "flex": self.flex,
+            "coordinator_endpoint": self.coordinator_endpoint,
+            "context": self.context,
+            "timestamp": self.timestamp,
+        }
+
+    @classmethod
+    def from_dict(cls, dikt):
+        return Context(
+            coordinator_endpoint=dikt.get("coordinator_endpoint"),
+            flex=dikt.get("flex"),
+            name=dikt.get("name"),
+            timestamp=dikt.get("timestamp"),
+            context=dikt.get("context"),
+            graph_name=dikt.get("graph_name", None),
+        )
+
+    def is_expired(self, validity_period=86400) -> bool:
+        current_timestamp = time.time()
+        if current_timestamp - self.timestamp > validity_period:
+            return True
+        return False
+
+    def reset_timestamp(self):
+        self.timestamp = time.time()
+
+
+class GSConfig(object):
+    def __init__(self, contexts, current_context: str):
+        self._contexts = contexts
+        self._current_context = current_context
+
+    def current_context(self) -> Context:
+        if self._current_context is None:
+            return None
+        if self._current_context not in self._contexts:
+            raise RuntimeError(
+                f"Failed to get current context: {self._current_context}"
+            )
+        return self._contexts[self._current_context]
+
+    def set_and_write(self, context: Context):
+        # treat the same endpoint with same services as the same coordinator
+        for _, v in self._contexts.items():
+            if (
+                context.coordinator_endpoint == v.coordinator_endpoint
+                and context.flex == v.flex
+            ):
+                # reset to global context
+                v.switch_context("global")
+                contexts = [v.to_dict() for _, v in self._contexts.items()]
+                write_yaml_file(
+                    {"contexts": contexts, "current-context": self._current_context},
+                    GS_CONFIG_DEFAULT_LOCATION,
+                )
+                return
+
+        # set
+        self._current_context = context.name
+        self._contexts[context.name] = context
+
+        # write
+        contexts = [v.to_dict() for _, v in self._contexts.items()]
+        write_yaml_file(
+            {"contexts": contexts, "current-context": self._current_context},
+            GS_CONFIG_DEFAULT_LOCATION,
+        )
+
+    def update_and_write(self, context: Context):
+        if context.name not in self._contexts:
+            raise RuntimeError(f"Failed to get context: {context.name}")
+
+        # update
+        self._contexts[context.name] = context
+
+        # write
+        contexts = [v.to_dict() for _, v in self._contexts.items()]
+        write_yaml_file(
+            {"contexts": contexts, "current-context": self._current_context},
+            GS_CONFIG_DEFAULT_LOCATION,
+        )
+
+    def remove_and_write(self, current_context: Context):
+        # remove
+        del self._contexts[current_context.name]
+        self._current_context = None
+
+        # write
+        contexts = [v.to_dict() for _, v in self._contexts.items()]
+        write_yaml_file(
+            {"contexts": contexts, "current-context": self._current_context},
+            GS_CONFIG_DEFAULT_LOCATION,
+        )
+
+
+class GSConfigLoader(object):
+    def __init__(self, config_file):
+        self._config_file = config_file
+
+    def _parse_config(self, config_dict):
+        if not config_dict:
+            return {}, None
+
+        current_context = config_dict["current-context"]
+        if current_context is None:
+            return {}, None
+
+        contexts = {}
+        current_context_exists = False
+        for c in config_dict["contexts"]:
+            if current_context == c["name"]:
+                current_context_exists = True
+            contexts[c["name"]] = Context.from_dict(c)
+
+        if not current_context_exists:
+            raise RuntimeError(
+                "Current context {0} is not exists in config file {1}".format(
+                    current_context, GS_CONFIG_DEFAULT_LOCATION
+                )
+            )
+
+        return contexts, current_context
+
+    def load_config(self):
+        config_dict = read_yaml_file(self._config_file)
+        contexts, current_context = self._parse_config(config_dict)
+        return GSConfig(contexts, current_context)
+
+
+def load_gs_config():
+    """Loads cluster and context information from gs-config file
+    and stores them in Config.
+    """
+    config_file = GS_CONFIG_DEFAULT_LOCATION
+
+    # create config file is not exists
+    if not os.path.exists(config_file):
+        workdir = os.path.dirname(config_file)
+        os.makedirs(workdir, exist_ok=True)
+        write_yaml_file({}, config_file)
+
+    loader = GSConfigLoader(config_file)
+    return loader.load_config()
+
+
+def get_current_context():
+    config = load_gs_config()
+    return config.current_context()

graphscope/gsctl/gsctl.py

@@ -0,0 +1,51 @@
+#!/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 os
+import sys
+
+import click
+
+try:
+    import graphscope
+    from graphscope.gsctl.commands import get_command_collection
+    from graphscope.gsctl.config import get_current_context
+except ModuleNotFoundError:
+    # if graphscope is not installed, only basic functions or utilities
+    # can be used, e.g. install dependencies
+    graphscope = None
+
+
+def cli():
+    if graphscope is None:
+        sys.path.insert(
+            0, os.path.join(os.path.dirname(os.path.realpath(__file__)), "commands")
+        )
+        from dev import cli as dev_cli
+
+        dev_cli()
+
+    context = get_current_context()
+    # get the specified commands under the FLEX architecture
+    commands = get_command_collection(context)
+    # serve the command
+    commands()
+
+
+if __name__ == "__main__":
+    cli()

graphscope/gsctl/impl/__init__.py

@@ -0,0 +1,64 @@
+#!/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 graphscope.gsctl.impl.alert import create_alert_receiver
+from graphscope.gsctl.impl.alert import delete_alert_message_in_batch
+from graphscope.gsctl.impl.alert import delete_alert_receiver_by_id
+from graphscope.gsctl.impl.alert import delete_alert_rule_by_id
+from graphscope.gsctl.impl.alert import list_alert_messages
+from graphscope.gsctl.impl.alert import list_alert_receivers
+from graphscope.gsctl.impl.alert import list_alert_rules
+from graphscope.gsctl.impl.alert import update_alert_message_in_batch
+from graphscope.gsctl.impl.alert import update_alert_receiver_by_id
+from graphscope.gsctl.impl.alert import update_alert_rule_by_id
+from graphscope.gsctl.impl.common import connect_coordinator
+from graphscope.gsctl.impl.common import disconnect_coordinator
+from graphscope.gsctl.impl.datasource import bind_datasource_in_batch
+from graphscope.gsctl.impl.datasource import get_datasource_by_id
+from graphscope.gsctl.impl.datasource import unbind_edge_datasource
+from graphscope.gsctl.impl.datasource import unbind_vertex_datasource
+from graphscope.gsctl.impl.deployment import get_deployment_pod_log
+from graphscope.gsctl.impl.deployment import get_deployment_resource_usage
+from graphscope.gsctl.impl.deployment import get_deployment_status
+from graphscope.gsctl.impl.deployment import get_storage_usage
+from graphscope.gsctl.impl.graph import create_edge_type
+from graphscope.gsctl.impl.graph import create_graph
+from graphscope.gsctl.impl.graph import create_vertex_type
+from graphscope.gsctl.impl.graph import delete_edge_type_by_name
+from graphscope.gsctl.impl.graph import delete_graph_by_id
+from graphscope.gsctl.impl.graph import delete_vertex_type_by_name
+from graphscope.gsctl.impl.graph import get_graph_by_id
+from graphscope.gsctl.impl.graph import get_graph_id_by_name
+from graphscope.gsctl.impl.graph import get_graph_name_by_id
+from graphscope.gsctl.impl.graph import import_schema
+from graphscope.gsctl.impl.graph import list_graphs
+from graphscope.gsctl.impl.job import delete_job_by_id
+from graphscope.gsctl.impl.job import get_job_by_id
+from graphscope.gsctl.impl.job import list_jobs
+from graphscope.gsctl.impl.job import submit_dataloading_job
+from graphscope.gsctl.impl.service import list_service_status
+from graphscope.gsctl.impl.service import restart_service
+from graphscope.gsctl.impl.service import start_service
+from graphscope.gsctl.impl.service import stop_service
+from graphscope.gsctl.impl.stored_procedure import create_stored_procedure
+from graphscope.gsctl.impl.stored_procedure import delete_stored_procedure_by_id
+from graphscope.gsctl.impl.stored_procedure import get_stored_procedure_by_id
+from graphscope.gsctl.impl.stored_procedure import list_stored_procedures
+from graphscope.gsctl.impl.stored_procedure import update_stored_procedure_by_id
+from graphscope.gsctl.impl.utils import switch_context
+from graphscope.gsctl.impl.utils import upload_file