MeshDB
MeshDB Schema Design
(updated September 2024 based on schema changes) Background MeshDB is an software application...
MeshDB Status Values
This page lists all the possible values for the status field on each MeshDB database object. For ...
How to onboard API clients to MeshDB
These instructions are for creating API access for automated systems. For human users, see How to...
How to Onboard Users to MeshDB
These instructions are for creating administrator console access for human users. For automated s...
SQL Explorer (formerly PGAdmin)
For more in depth access to MeshDB's datebase, you can use the SQL Explorer tool to perform com...
How to bulk create installs for large buildings
These instructions detail how to provision many Install requests at once. Usually this is done at...
How to avoid manually entering latitude/longitude/altitude when constructing Node objects
When constructing or editing Node objects, users are presented with the following fields: Sinc...
How to assign a "vanity" network number
These instructions are only needed when precise control of the exact NN is required. Most install...
How to add potential Hubs and Links to the map
To add potential hubs and links to the map using MeshDB, you must create the appropriate database...
How to update MeshDB when an install is completed
When an install is completed, there are a few items to confirm are correct in MeshDB so that we h...
How to update MeshDB to indicate the loss of an install
When an install leaves the mesh, MeshDB needs to be kept up-to-date to ensure we have accurate me...
New Application Integration Guide
So you want to build an application which interacts with MeshDB data. Great! First, familiarize...
Environments
We run several instances of MeshDB. This is so that we can do development and testing, gate our c...
Maintenance Mode
MeshDB has a maintenance mode. It prevents all access to the site, UI, and API while active. To ...
Observability
We use Datadog to monitor MeshDB. Dashboard https://p.us5.datadoghq.com/sb/4614e554-06a1-11ef-b...
Admin Panel
MeshDB Domains
Environment Service Link Production MeshDB https://db.nycmesh.net Mesh Forms ...
Feature Flags
We use a library to control whether certain features are enabled. To enable a feature, go to ...
Panoramas
The way that panoramas currently work in MeshDB sucks. They are uploaded to a github repo (https:...
How to Import/Export CSV files of MeshDB data
The data in MeshDB is best viewed using the tooling available at db.nycmesh.net: Admin Panel: ...
How to View the Edit History for an Object in MeshDB
MeshDB tracks the changes to all objects from all actors. Any change via the admin panel, API, or...