gsctl 0.29.0a20250114__py2.py3-none-any.whl

graphscope/gsctl/commands/insight/graph.py

@@ -0,0 +1,205 @@
+#!/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_edge_type
+from graphscope.gsctl.impl import create_vertex_type
+from graphscope.gsctl.impl import delete_edge_type_by_name
+from graphscope.gsctl.impl import delete_vertex_type_by_name
+from graphscope.gsctl.impl import get_datasource_by_id
+from graphscope.gsctl.impl import import_schema
+from graphscope.gsctl.impl import list_graphs
+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 use():
+    """Switch back to the global scope"""
+    pass
+
+
+@cli.group()
+def delete():
+    """Delete vertex or edge type by name"""
+    pass
+
+
+@cli.group()
+def create():
+    """Create vertex or edge type from file"""
+    pass
+
+
+@cli.command()
+def ls():  # noqa: F811
+    """Display schema and data source mapping 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)
+    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 schema(filename):  # noqa: F811
+    """Import schema 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:
+        schema = read_yaml_file(filename)
+        import_schema(graph_identifier, schema)
+    except Exception as e:
+        err(f"Failed to import schema: {str(e)}")
+    else:
+        succ("Import schema successfully.")
+
+
+@create.command()
+@click.option(
+    "-f",
+    "--filename",
+    required=True,
+    help="Path of yaml file",
+)
+def vertex_type(filename):  # noqa: F811
+    """Create a vertex type 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:
+        vtype = read_yaml_file(filename)
+        create_vertex_type(graph_identifier, vtype)
+    except Exception as e:
+        err(f"Failed to create vertex type: {str(e)}")
+    else:
+        succ(f"Create vertex type {vtype['type_name']} successfully.")
+
+
+@delete.command()
+@click.argument("vertex_type", required=True)
+def vertex_type(vertex_type):  # noqa: F811
+    """Delete a vertex type by name"""
+    current_context = get_current_context()
+    graph_identifier = current_context.context
+    try:
+        delete_vertex_type_by_name(graph_identifier, vertex_type)
+    except Exception as e:
+        err(f"Failed to delete vertex type {vertex_type}: {str(e)}")
+    else:
+        succ(f"Delete vertex type {vertex_type} successfully.")
+
+
+@create.command()
+@click.option(
+    "-f",
+    "--filename",
+    required=True,
+    help="Path of yaml file",
+)
+def edge_type(filename):  # noqa: F811
+    """Create an edge type 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:
+        etype = read_yaml_file(filename)
+        create_edge_type(graph_identifier, etype)
+    except Exception as e:
+        err(f"Failed to create edge type: {str(e)}")
+    else:
+        succ(f"Create edge type {etype['type_name']} successfully.")
+
+
+@delete.command()
+@click.argument("edge_type", required=True)
+@click.option(
+    "-s",
+    "--source_vertex_type",
+    required=True,
+    help="Source vertex type of the edge",
+)
+@click.option(
+    "-d",
+    "--destination_vertex_type",
+    required=True,
+    help="Destination vertex type of the edge",
+)
+def edge_type(edge_type, source_vertex_type, destination_vertex_type):  # noqa: F811
+    """Delete an edge type by name"""
+    current_context = get_current_context()
+    graph_identifier = current_context.context
+    try:
+        etype_full_name = (
+            f"({source_vertex_type})-[{edge_type}]->({destination_vertex_type})"
+        )
+        delete_edge_type_by_name(
+            graph_identifier, edge_type, source_vertex_type, destination_vertex_type
+        )
+    except Exception as e:
+        err(f"Failed to delete edge type {etype_full_name}: {str(e)}")
+    else:
+        succ(f"Delete edge type {etype_full_name} successfully.")
+
+
+@use.command(name="GLOBAL")
+def _global():
+    """Switch back to the global scope"""
+    switch_context("global")
+    click.secho("Using GLOBAL", fg="green")

graphscope/gsctl/commands/interactive/__init__.py

@@ -0,0 +1,17 @@
+#!/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.
+#

graphscope/gsctl/commands/interactive/glob.py

@@ -0,0 +1,280 @@
+#!/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.impl import bind_datasource_in_batch
+from graphscope.gsctl.impl import create_graph
+from graphscope.gsctl.impl import delete_graph_by_id
+from graphscope.gsctl.impl import delete_job_by_id
+from graphscope.gsctl.impl import get_datasource_by_id
+from graphscope.gsctl.impl import get_graph_id_by_name
+from graphscope.gsctl.impl import get_graph_name_by_id
+from graphscope.gsctl.impl import get_job_by_id
+from graphscope.gsctl.impl import list_graphs
+from graphscope.gsctl.impl import list_jobs
+from graphscope.gsctl.impl import list_service_status
+from graphscope.gsctl.impl import list_stored_procedures
+from graphscope.gsctl.impl import start_service
+from graphscope.gsctl.impl import submit_dataloading_job
+from graphscope.gsctl.impl import switch_context
+from graphscope.gsctl.impl import unbind_edge_datasource
+from graphscope.gsctl.impl import unbind_vertex_datasource
+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 graph, data source, loader job from file"""
+    pass
+
+
+@cli.group()
+def delete():
+    """Delete graph, data source, loader job by id"""
+    pass
+
+
+@cli.group()
+def desc():
+    """Show job's details by id"""
+    pass
+
+
+@cli.command()
+@click.argument(
+    "context", type=click.Choice(["GRAPH"], case_sensitive=False), required=True
+)
+@click.argument("GRAPH_IDENTIFIER", required=True)
+def use(context, graph_identifier):
+    """Switch to GRAPH context, see identifier with `ls` command"""
+    try:
+        graph_identifier = get_graph_id_by_name(graph_identifier)
+        graph_name = get_graph_name_by_id(graph_identifier)
+        status = list_service_status()
+        for s in status:
+            if s.graph_id == graph_identifier and s.status != "Running":
+                info(
+                    f"Starting service on graph {graph_name}(id={graph_identifier})..."
+                )
+                start_service(graph_identifier)
+        switch_context(graph_identifier, graph_name)
+    except Exception as e:
+        err(f"Failed to switch context: {str(e)}")
+    else:
+        click.secho(f"Using GRAPH {graph_name}(id={graph_identifier})", fg="green")
+
+
+@cli.command()
+@click.option("-l", is_flag=True, help="List sub resources recursively")
+def ls(l):  # noqa: F811, E741
+    """Display graph resources in database"""
+    tree = TreeDisplay()
+    try:
+        graphs = list_graphs()
+        for g in graphs:
+            # schema
+            tree.create_graph_node(g, recursive=l)
+            if l:
+                # data source mapping
+                datasource_mapping = get_datasource_by_id(g.id)
+                tree.create_datasource_mapping_node(g, datasource_mapping)
+                # stored procedure
+                stored_procedures = list_stored_procedures(g.id)
+                tree.create_stored_procedure_node(g, stored_procedures)
+                # job
+                jobs = list_jobs()
+                tree.create_job_node(g, jobs)
+    except Exception as e:
+        err(f"Failed to list resources: {str(e)}")
+    else:
+        tree.show()
+        if not l:
+            info("Run `gsctl ls -l` to list all resources recursively.")
+
+
+@create.command()
+@click.option(
+    "-f",
+    "--filename",
+    required=True,
+    help="Path of yaml file",
+)
+def graph(filename):  # noqa: F811
+    """Create a new graph in database"""
+    if not is_valid_file_path(filename):
+        err(f"Invalid file: {filename}")
+        return
+    try:
+        graph = read_yaml_file(filename)
+        graph_id = create_graph(graph)
+    except Exception as e:
+        err(f"Failed to create graph: {str(e)}")
+    else:
+        succ(f"Create graph {graph['name']}(id={graph_id}) successfully.")
+
+
+@delete.command()
+@click.argument("graph_identifier", required=True)
+def graph(graph_identifier):  # noqa: F811
+    """Delete a graph, see graph identifier with `ls` command"""
+    try:
+        if click.confirm("Do you want to continue?"):
+            delete_graph_by_id(get_graph_id_by_name(graph_identifier))
+            succ(f"Delete graph {graph_identifier} successfully.")
+    except Exception as e:
+        err(f"Failed to delete graph {graph_identifier}: {str(e)}")
+
+
+@create.command
+@click.option(
+    "-g",
+    "--graph_identifier",
+    required=True,
+    help="See graph identifier with `ls` command",
+)
+@click.option(
+    "-f",
+    "--filename",
+    required=True,
+    help="Path of yaml file",
+)
+def datasource(graph_identifier, filename):  # noqa: F811
+    """Bind data source mapping from file"""
+    if not is_valid_file_path(filename):
+        err(f"Invalid file: {filename}")
+        return
+    graph_identifier = get_graph_id_by_name(graph_identifier)
+    try:
+        datasource = read_yaml_file(filename)
+        bind_datasource_in_batch(graph_identifier, datasource)
+    except Exception as e:
+        err(f"Failed to bind data source: {str(e)}")
+    else:
+        succ("Bind data source successfully.")
+
+
+@delete.command
+@click.option(
+    "-g",
+    "--graph_identifier",
+    required=True,
+    help="See graph identifier with `ls` command",
+)
+@click.option(
+    "-t",
+    "--type",
+    required=True,
+    help="Vertex or edge type",
+)
+@click.option(
+    "-s",
+    "--source_vertex_type",
+    required=False,
+    help="Source vertex type of the edge [edge only]",
+)
+@click.option(
+    "-d",
+    "--destination_vertex_type",
+    required=False,
+    help="Destination vertex type of the edge [edge only]",
+)
+def datasource(  # noqa: F811
+    graph_identifier, type, source_vertex_type, destination_vertex_type
+):
+    """Unbind data source mapping on vertex or edge type"""
+    try:
+        graph_identifier = get_graph_id_by_name(graph_identifier)
+        if source_vertex_type is not None and destination_vertex_type is not None:
+            unbind_edge_datasource(
+                graph_identifier, type, source_vertex_type, destination_vertex_type
+            )
+        else:
+            unbind_vertex_datasource(graph_identifier, type)
+    except Exception as e:
+        err(f"Failed to unbind data source: {str(e)}")
+    else:
+        succ("Unbind data source successfully.")
+
+
+@create.command()
+@click.option(
+    "-g",
+    "--graph_identifier",
+    required=True,
+    help="See graph identifier with `ls` command",
+)
+@click.option(
+    "-f",
+    "--filename",
+    required=True,
+    help="Path of yaml file",
+)
+def loaderjob(graph_identifier, filename):  # noqa: F811
+    """Create a data loading job from file"""
+    if not is_valid_file_path(filename):
+        err(f"Invalid file: {filename}")
+        return
+    graph_identifier = get_graph_id_by_name(graph_identifier)
+    try:
+        config = read_yaml_file(filename)
+        jobid = submit_dataloading_job(graph_identifier, config)
+    except Exception as e:
+        err(f"Failed to create a job: {str(e)}")
+    else:
+        succ(f"Create job {jobid} successfully.")
+
+
+@delete.command()
+@click.argument("identifier", required=True)
+def job(identifier):  # noqa: F811
+    """Cancel a job, see identifier with `ls` command"""
+    try:
+        if click.confirm("Do you want to continue?"):
+            delete_job_by_id(identifier)
+            succ(f"Delete job {identifier} successfully.")
+    except Exception as e:
+        err(f"Failed to delete job {identifier}: {str(e)}")
+
+
+@desc.command()
+@click.argument("identifier", required=True)
+def job(identifier):  # noqa: F811
+    """Show details of job, see identifier with `ls` command"""
+    try:
+        job = get_job_by_id(identifier)
+    except Exception as e:
+        err(f"Failed to get job: {str(e)}")
+    else:
+        info(yaml.dump(job.to_dict()))
+
+
+if __name__ == "__main__":
+    cli()