Destroy

destroy feature can delete a dataset stored on disk or close a connection in memory.

You can write a Geist template with the destroy tag. You can also use CLI or Python API step by step as follows:

CLI: destroy commandPython API: destroy functionPython API: destroy method of the Connection ClassPython API: close method of the Connection Class

destroy command can delete a dataset. The .duckdb or the .pkl file of the corresponding dataset will be discarded.

There are two subcommands for destroy:

Usage: geist destroy [OPTIONS] COMMAND [ARGS]...

  Delete a dataset

Options:
  --help  Show this message and exit.

Commands:
  duckdb  Delete a SQL dataset
  rdflib  Delete an RDF dataset

geist destroy duckdb [OPTIONS]

Usage: geist destroy duckdb [OPTIONS]

Delete a SQL dataset

Options:
-d, --dataset TEXT  Name of SQL dataset to be removed (default "kb")
-q, --quiet         Suppress error messages if the provided dataset does not
                    exist
--help              Show this message and exit.

Example: delete the test dataset

geist destroy duckdb --dataset test

The .geistdata/duckdb/test.duckdb file will be removed after this operation. By default, you will get an error message if the provided dataset (in this case, it is the test dataset) does not exist. To suppress this error message, you can add --quiet:

geist destroy duckdb --dataset test --quiet

geist destroy rdflib [OPTIONS]

Usage: geist destroy rdflib [OPTIONS]

Delete an RDF dataset

Options:
-d, --dataset TEXT  Name of RDF dataset to be removed (default "kb")
-q, --quiet         Suppress error messages if the provided dataset does not
                    exist
--help              Show this message and exit.

Example: delete the test dataset

geist destroy rdflib --dataset test

The .geistdata/rdflib/test.pkl file will be removed after this operation. By default, you will get an error message if the provided dataset (in this case, it is the test dataset) does not exist. To suppress this error message, you can add --quiet:

geist destroy rdflib --dataset test --quiet

destroy function can delete a dataset.

Parameters description for destroy():

Name	Type	Description	Default
datastore	string	A backend datastore, i.e., `'rdflib'` or `'duckdb'`	REQUIRED
dataset	string	Name of the dataset to be removed	REQUIRED
quiet	bool	`True` to suppress error messages if the provided dataset does not exist	`False`

Example: delete the test dataset

import geist
geist.destroy(datastore='rdflib', dataset='test')

The .geistdata/rdflib/test.pkl file will be removed after this operation. By default, you will get an error message if the provided dataset (in this case, it is the test dataset) does not exist. To suppress this error message, you can set quiet=True:

import geist
geist.destroy(datastore='rdflib', dataset='test', quiet=True)

destroy method of the Connection class is to delete the dataset and close the dataset connection.

Example: delete the dataset and close the connection

Suppose connection is the instance of the Connection class for a DuckDB dataset named test stored on disk. The following code will delete the .geistdata/duckdb/test.duckdb file.

# Delete the dataset and close the connection
connection.destroy()

close method of the Connection class is to close the dataset connection, i.e., reset all attributes to None. No parameters are required.

Example: close the connection

Suppose connection is the instance of the Connection class.

# Close the connection
connection.close()