Skip to content

Commit

Permalink
Add notice in readme to cover indices and sbn mirror
Browse files Browse the repository at this point in the history
  • Loading branch information
ntellis committed Oct 5, 2023
1 parent 2056678 commit efd93dd
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,22 @@

This is a client library for interacting with an MPC observations database.

## Notice

The Asteroid Institute hosts a private mirror of the Minor Planet Center's Small Bodies Node.

To set up your own mirror, please see the [SBN guidelines](https://sbnwiki.astro.umd.edu/wiki/). While support is planned for connecting to an arbitrary database mirror, the current version of this package only supports connecting to a hosted Cloud SQL instance on GCP.

Two indices on the observation table have been added for performance reasons. They are listed below with their sql definitions:
- obs_sbn_submission_id
```sql
CREATE INDEX obs_sbn_submission_id ON public.obs_sbn USING hash (submission_id);
```
- obs_sbn_provid
```sql
CREATE INDEX obs_sbn_provid ON public.obs_sbn USING hash (provid)
```

## Usage

To connect to the Asteroid Institute's clone of the Small Bodies Node MPC database:
Expand Down Expand Up @@ -58,4 +74,4 @@ print(submissions_df)
5 2011-04-12T00:57:19.000_00005L9j 3 2011-04-12 00:57:19.000
6 2016-04-03T19:54:29.000_00006IpM 3 2016-04-03 19:54:29.000
7 2015-01-16T23:14:02.000_00005wg5 3 2015-01-16 23:14:02.000
```
```

0 comments on commit efd93dd

Please sign in to comment.