DESC data management
Overview:
Installation
Using the
dataregistry
at NERSC
Access accounts
Authenticating with the database
Tutorials:
Getting set up
Working with the data registry tutorial notebooks interactively
The
dataregistry
package
1) Getting started with the data registry
2) Advanced tutorials
The
dataregistry
CLI
Registering a dataset
Updating a dataset
Querying the data registry
Data Registry CLI Cheat Sheet
Overview
Main Commands
🟦 Querying from the Command Line 🟦
🟩 Registering a Dataset 🟩
🟨 Modifying a Dataset 🟨
🟥 Deleting a Dataset 🟥
Reference:
The
dataregistry
package
The DataRegistry class
The
dregs
CLI
dregs
Database schema
The execution table
The provenance table
The execution_alias table
The dataset table
The dependency table
The dataset_alias table
Developer notes:
SPIN
Database structure
The database schemas
First time creation of database schemas
Local installation
Creating a Conda environment
Creating a Python venv
Installing the
dataregistry
package
Install from source
Contact:
Contact
DESC data management
Index
Index
Symbols
|
A
|
C
|
D
|
F
|
G
|
M
|
N
|
O
|
R
|
V
Symbols
--access_api
dregs-register-dataset command line option
--config_file
dregs-delete-dataset command line option
dregs-delete-dataset_by_id command line option
dregs-ls command line option
dregs-modify-dataset command line option
dregs-register-dataset command line option
dregs-show-keywords command line option
--contact_email
dregs-register-dataset command line option
--creation_date
dregs-register-dataset command line option
--description
dregs-register-dataset command line option
--entry_mode
dregs-delete-dataset command line option
dregs-delete-dataset_by_id command line option
dregs-ls command line option
dregs-modify-dataset command line option
dregs-register-dataset command line option
dregs-show-keywords command line option
--execution_configuration
dregs-register-dataset command line option
--execution_description
dregs-register-dataset command line option
--execution_id
dregs-register-dataset command line option
--execution_name
dregs-register-dataset command line option
--execution_site
dregs-register-dataset command line option
--execution_start
dregs-register-dataset command line option
--help
dregs command line option
dregs-delete command line option
dregs-delete-dataset command line option
dregs-delete-dataset_by_id command line option
dregs-ls command line option
dregs-modify command line option
dregs-modify-dataset command line option
dregs-register command line option
dregs-register-dataset command line option
dregs-show command line option
dregs-show-keywords command line option
--input_datasets
dregs-register-dataset command line option
--is_overwritable
dregs-register-dataset command line option
--keyword
dregs-ls command line option
--keywords
dregs-register-dataset command line option
--location_type
dregs-register-dataset command line option
--max_chars
dregs-ls command line option
--max_rows
dregs-ls command line option
--name
dregs-ls command line option
--namespace
dregs-delete-dataset command line option
dregs-delete-dataset_by_id command line option
dregs-ls command line option
dregs-modify-dataset command line option
dregs-register-dataset command line option
dregs-show-keywords command line option
--old_location
dregs-register-dataset command line option
--owner
dregs-ls command line option
dregs-register-dataset command line option
--owner_type
dregs-ls command line option
dregs-register-dataset command line option
--relative_path
dregs-register-dataset command line option
--return_cols
dregs-ls command line option
--root_dir
dregs-delete-dataset command line option
dregs-delete-dataset_by_id command line option
dregs-ls command line option
dregs-modify-dataset command line option
dregs-register-dataset command line option
dregs-show-keywords command line option
--schema
dregs-delete-dataset command line option
dregs-delete-dataset_by_id command line option
dregs-ls command line option
dregs-modify-dataset command line option
dregs-register-dataset command line option
dregs-show-keywords command line option
--site
dregs-delete-dataset command line option
dregs-delete-dataset_by_id command line option
dregs-ls command line option
dregs-modify-dataset command line option
dregs-register-dataset command line option
dregs-show-keywords command line option
--url
dregs-register-dataset command line option
-h
dregs command line option
dregs-delete command line option
dregs-delete-dataset command line option
dregs-delete-dataset_by_id command line option
dregs-ls command line option
dregs-modify command line option
dregs-modify-dataset command line option
dregs-register command line option
dregs-register-dataset command line option
dregs-show command line option
dregs-show-keywords command line option
A
add_keywords() (dataregistry.registrar.dataset.DatasetTable method)
C
column
dregs-modify-dataset command line option
D
DataRegistry (class in dataregistry)
dataset_id
dregs-delete-dataset_by_id command line option
dregs-modify-dataset command line option
delete() (dataregistry.registrar.dataset.DatasetTable method)
dregs command line option
--help
-h
dregs-delete command line option
--help
-h
dregs-delete-dataset command line option
--config_file
--entry_mode
--help
--namespace
--root_dir
--schema
--site
-h
name
owner
owner_type
version_string
dregs-delete-dataset_by_id command line option
--config_file
--entry_mode
--help
--namespace
--root_dir
--schema
--site
-h
dataset_id
dregs-ls command line option
--config_file
--entry_mode
--help
--keyword
--max_chars
--max_rows
--name
--namespace
--owner
--owner_type
--return_cols
--root_dir
--schema
--site
-h
dregs-modify command line option
--help
-h
dregs-modify-dataset command line option
--config_file
--entry_mode
--help
--namespace
--root_dir
--schema
--site
-h
column
dataset_id
new_value
dregs-register command line option
--help
-h
dregs-register-dataset command line option
--access_api
--config_file
--contact_email
--creation_date
--description
--entry_mode
--execution_configuration
--execution_description
--execution_id
--execution_name
--execution_site
--execution_start
--help
--input_datasets
--is_overwritable
--keywords
--location_type
--namespace
--old_location
--owner
--owner_type
--relative_path
--root_dir
--schema
--site
--url
-h
name
version
dregs-show command line option
--help
-h
dregs-show-keywords command line option
--config_file
--entry_mode
--help
--namespace
--root_dir
--schema
--site
-h
F
find_datasets() (dataregistry.DataRegistry.Query method)
G
get_keywords() (dataregistry.registrar.dataset.DatasetTable method)
get_modifiable_columns() (dataregistry.registrar.dataset.DatasetTable method)
get_owner_types() (dataregistry.DataRegistry.Registrar method)
M
modify() (dataregistry.registrar.dataset.DatasetTable method)
N
name
dregs-delete-dataset command line option
dregs-register-dataset command line option
new_value
dregs-modify-dataset command line option
O
owner
dregs-delete-dataset command line option
owner_type
dregs-delete-dataset command line option
R
register() (dataregistry.registrar.dataset.DatasetTable method)
(dataregistry.registrar.dataset_alias.DatasetAliasTable method)
(dataregistry.registrar.execution.ExecutionTable method)
replace() (dataregistry.registrar.dataset.DatasetTable method)
V
version
dregs-register-dataset command line option
version_string
dregs-delete-dataset command line option