remote/sqlite-utils
1
0
Fork 0
mirror of https://github.com/simonw/sqlite-utils.git synced 2026-09-28 21:04:13 +02:00
Code Issues Projects Releases Packages Wiki Activity

Use docstring instead of help arg

Browse source
This commit is contained in:
Chris Amico 2022-02-15 13:06:49 -05:00
commit 00b650c684
1 changed files with 11 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

26
sqlite_utils/cli.py
View file

@ -2714,13 +2714,7 @@ def convert(
) )
@cli.command( @cli.command("add-geometry-column")
"add-geometry-column",
help="""Add a SpatiaLite geometry column to an existing table. Requires SpatiaLite extension.
\n\n
By default, this command will try to load the SpatiaLite extension from usual paths.
To load it from a specific path, use --load-extension.""",
)
@click.argument( @click.argument(
"db_path", "db_path",
type=click.Path(file_okay=True, dir_okay=False, allow_dash=False), type=click.Path(file_okay=True, dir_okay=False, allow_dash=False),
@ -2775,6 +2769,10 @@ def add_geometry_column(
not_null, not_null,
load_extension, load_extension,
): ):
"""Add a SpatiaLite geometry column to an existing table. Requires SpatiaLite extension.
\n\n
By default, this command will try to load the SpatiaLite extension from usual paths.
To load it from a specific path, use --load-extension."""
db = sqlite_utils.Database(db_path) db = sqlite_utils.Database(db_path)
if not db[table].exists(): if not db[table].exists():
raise click.ClickException( raise click.ClickException(
@ -2792,14 +2790,7 @@ def add_geometry_column(
click.echo(f"Added {geometry_type} column {column_name} to {table}") click.echo(f"Added {geometry_type} column {column_name} to {table}")
@cli.command( @cli.command("create-spatial-index")
"create-spatial-index",
help="""Create a spatial index on a SpatiaLite geometry column.
The table and geometry column must already exist before trying to add a spatial index.
\n\n
By default, this command will try to load the SpatiaLite extension from usual paths.
To load it from a specific path, use --load-extension.""",
)
@click.argument( @click.argument(
"db_path", "db_path",
type=click.Path(file_okay=True, dir_okay=False, allow_dash=False), type=click.Path(file_okay=True, dir_okay=False, allow_dash=False),
@ -2809,6 +2800,11 @@ To load it from a specific path, use --load-extension.""",
@click.argument("column_name", type=str) @click.argument("column_name", type=str)
@load_extension_option @load_extension_option
def create_spatial_index(db_path, table, column_name, load_extension): def create_spatial_index(db_path, table, column_name, load_extension):
"""Create a spatial index on a SpatiaLite geometry column.
The table and geometry column must already exist before trying to add a spatial index.
\n\n
By default, this command will try to load the SpatiaLite extension from usual paths.
To load it from a specific path, use --load-extension."""
db = sqlite_utils.Database(db_path) db = sqlite_utils.Database(db_path)
if not db[table].exists(): if not db[table].exists():
raise click.ClickException( raise click.ClickException(