Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Glossary

A reference of abbreviations, acronyms, and domain-specific language used throughout this project.

Platform Terms

TermDefinition
CollectionA curated grouping of datasets for organizational or meta-analysis purposes. See Collections & Tags.
CompartmentA structural subdivision of a neuron that maps to a SynDB table.
DatasetA collection of neuroanatomical measurements sharing species, brain region, microscopy, and other metadata.
ETLExtract, Transform, Load: imports external datasets into SynDB’s schema. See External sources.
ProvenanceThe audit trail tracking who created, modified, or derived from a dataset. See Provenance & Citations.
SyQLSynDB Query Language: a declarative SQL-like language resolving dataset metadata into optimized ClickHouse queries. See SyQL.
TableA typed schema corresponding to a neuronal compartment, with its own column definitions.

Neuroscience Terms

TermDefinition
ConnectomeA comprehensive map of neural connections in a nervous system. Background.
NeuronAn electrically excitable cell that communicates via synapses; identified by neuron_id. CL:0000540.
SynapseA junction between neurons where signals are transmitted chemically or electrically. GO:0045202.
AxonProjection conducting electrical impulses away from the cell body. GO:0030424.
DendriteBranched projection receiving signals. GO:0030425.
SomaCell body of a neuron
BoutonTerminal bulb of an axon (pre-synaptic ending)
Pre-synaptic terminalOutput side of a synapse; releases neurotransmitters. GO:0098793.
Post-synaptic terminalInput side of a synapse; receives neurotransmitters
Dendritic spineSmall dendritic protrusion forming the postsynaptic side of most excitatory synapses. GO:0043197.
Synaptic cleftGap between pre- and post-synaptic terminals
VesicleMembrane-bound compartment containing neurotransmitters in the pre-synaptic terminal. GO:0099503.
Active zone (AZ)Specialized region of the pre-synaptic terminal where vesicles fuse and release neurotransmitter
MitochondriaOrganelles responsible for ATP production. GO:0005739.
Endoplasmic reticulum (ER)Intracellular membrane system involved in protein synthesis
NucleusCell nucleus containing DNA
NeuropilDense neural tissue composed of intertwined axons, dendrites, and synapses
Connection strengthSynaptic weight or efficacy between two neurons
Cleft scorePredicted confidence of a synaptic cleft detection

Neuron Classification

TermDefinition
Cell typeClassification by morphology, connectivity, molecular markers, or electrophysiology (e.g., Pyramidal, Purkinje, Basket).
Cell classHigher-level grouping of neuron types
Cell subclassSubdivision within a cell class
PolarityMorphological arrangement of neuronal processes: Unipolar, Bipolar, Multipolar, Pseudounipolar, Anaxonic

Neurotransmitters

A neurotransmitter is a chemical substance released at a synapse to transmit signals.

AbbreviationFull Name
GABAGamma-aminobutyric acid (primary inhibitory neurotransmitter)
GlutamatePrimary excitatory neurotransmitter
AChAcetylcholine
5-HTSerotonin (5-hydroxytryptamine)
DopamineMonoamine neurotransmitter
NorepinephrineNoradrenaline; monoamine neurotransmitter
OctopamineInvertebrate monoamine neurotransmitter

Brain Regions

An anatomical or functional subdivision of the brain. SynDB uses terms from the UBERON multi-species anatomy ontology.

TermDefinition
CA1, CA3Sub-regions of the hippocampus (Cornu Ammonis)
DGDentate gyrus (hippocampal region)
V1Primary visual cortex
M1Primary motor cortex
S1Primary somatosensory cortex
PFCPrefrontal cortex
Mushroom bodyLearning/memory center in insect brains (Drosophila)
Antennal lobeOlfactory processing center in insect brains

Neuroanatomical Directions

TermMeaning
Anterior / PosteriorFront / back
Dorsal / VentralTop / bottom
Lateral / MedialSide / center
Rostral / CaudalToward the nose / toward the tail
Proximal / DistalClose to / far from the soma

Morphometrics

TermDefinition
Cable lengthTotal length of a neuronal skeletal reconstruction (axon or dendrite). Stored in the source’s unit — micrometres for FlyWire and mesh-connectomics; see Tables, columns and units.
Mesh volumeVolume of a 3D-reconstructed neuronal mesh
Sphericity / Mesh sphericityHow sphere-like a shape or mesh is (0–1; 1 is a perfect sphere).
N_branchesNumber of branching points in a neuronal arbor
CentroidSpatial center point (X, Y, Z) of a structure

Microscopy Techniques

AbbreviationFull Name
EMElectron microscopy
SEMScanning electron microscopy
TEMTransmission electron microscopy
SBEMSerial block-face electron microscopy
FIB-SEMFocused ion beam scanning electron microscopy
STEDStimulated emission depletion microscopy
PALMPhoto-activated localization microscopy
STORMStochastic optical reconstruction microscopy
CLEMCorrelative light and electron microscopy
SIMStructured illumination microscopy
ConfocalConfocal laser scanning microscopy
Two-photonTwo-photon excitation microscopy

Genetic Modifications

TermDefinition
Knock-out (KO)Complete deletion of a gene
Knock-in (KI)Insertion of a transgene
Knock-down (KD)Reduction of gene expression
OverexpressionArtificially increased gene expression

Model Organisms

Scientific NameCommon Name
Drosophila melanogasterFruit fly
Mus musculusMouse
Rattus norvegicusRat
Caenorhabditis elegansNematode worm
Danio rerioZebrafish

Known Connectome Datasets

NameDescription
FlyWireGoogle’s full Drosophila brain connectome
HemibrainJanelia’s Drosophila brain hemisphere connectome (via neuPrint)
MANCMale Adult Nervous System Connectome (Drosophila)
neuPrintFlyEM’s connectome query and database system

Data Formats & Standards

TermDefinition
NWBNeurodata Without Borders — standardized neuroscience data format
BIDSBrain Imaging Data Structure — standardized neuroimaging format
HDF5Hierarchical Data Format 5 — container format used by NWB
Apache ArrowIn-memory columnar data format for efficient analytics and transfer
Arrow IPCArrow inter-process communication serialization format
Arrow FlightApache Arrow’s gRPC protocol for streaming columnar data (default port 50051).
ParquetColumnar on-disk storage format
FeatherLightweight Arrow-native file format
DOIDigital Object Identifier (e.g., 10.1038/...); uniquely identifies publications
SWBSpatial Web Bundle — volumetric data format for neuroscience

Data Licenses

AbbreviationFull Name
CC0Creative Commons Zero (public domain)
CC-BYCreative Commons Attribution
CC-BY-SACreative Commons Attribution-ShareAlike
CC-BY-NCCreative Commons Attribution-NonCommercial
CC-BY-NC-SACreative Commons Attribution-NonCommercial-ShareAlike
PDDLPublic Domain Dedication and License
ODC-BYOpen Data Commons Attribution
ODC-ODbLOpen Data Commons Open Database License

Graph Analysis

TermDefinition
DiGraphDirected graph (via the petgraph library)
In-degreeNumber of incoming connections to a node
Out-degreeNumber of outgoing connections from a node
ReciprocityProportion of bidirectional edges in the graph
DensityRatio of actual edges to maximum possible edges
SCCStrongly connected component — maximal subgraph where every node is reachable from every other
Hub neuronHighly connected central node in the connectome
Triadic censusCount of all 16 possible directed 3-node subgraph (motif) types.
Feed-forward motifA → B → C with A → C
Convergent motifA → C, B → C (shared target)
Divergent motifA → B, A → C (shared source)
Cyclic motifA → B → C → A loop
Reciprocal motifBidirectional pair A ↔ B
ReachabilitySet of nodes reachable within N hops (BFS)
Shortest pathMinimum-weight path between two nodes (Dijkstra)

Meta-Analysis & Statistics

TermDefinition
Meta-analysisStatistical method combining results across multiple datasets
Effect sizeStandardized measure of the magnitude of an observed effect
HeterogeneityVariation in results across studies
Z-scoreNumber of standard deviations a value is from the mean
Forest plotVisualization showing effect sizes and confidence intervals across studies
GroupSummaryStatsPer-group statistics: count (n), mean, standard deviation, variance, quantiles
MetricMeasurable quantity — Volume, SurfaceArea, CableLength, MeshVolume, MeshSphericity, NBranches, Strength, SynapseCount
GroupingDimensionAggregation level — Species, BrainStructure, CellType, Cluster, Dataset

ClickHouse & Analytics

TermDefinition
ClickHouseColumnar OLAP database optimized for real-time analytics
MergeTreeClickHouse table engine with automatic background merging of data parts
ReplicatedMergeTreeMergeTree with replication support
AggregatingMergeTreeMergeTree engine that stores pre-aggregated states
Materialized view (MV)Pre-aggregated data maintained on insert; eligible SyQL queries can be rewritten to use it.
Trigger viewInserts that populate a materialized view’s target table
-Merge combinatorsClickHouse functions that finalize aggregate states (countMerge(), avgMerge(), stddevPopMerge())
Low cardinalityClickHouse column encoding for categorical/enum-like data
DateTime64(3)Millisecond-precision timestamp type
Enum8 / Enum16ClickHouse enumeration types (8-bit / 16-bit)
OPTIMIZE TABLE FINALForces consolidation of all data parts in a MergeTree table
Pre-Merge / Post-MergeQuery timing relative to an OPTIMIZE TABLE FINAL operation
JSONEachRowClickHouse format: one JSON object per line
RowBinaryClickHouse compact binary row format
ShardHorizontal partition of a ClickHouse cluster
ReplicaRedundant copy of a shard for fault tolerance
remoteSecure()ClickHouse function for querying remote clusters over TLS
KeeperClickHouse Keeper — ZooKeeper-compatible coordination service built into ClickHouse

SynDB Tables (SyndbTable discriminant)

IDTable
1Neuron
2NeuronRelation
3Dendrite
4Axon
5PreSynapticTerminal
6Synapse
7DendriticSpine
8EndoplasmicReticulum
9Nucleus
10Vesicle
11Mitochondria

Authentication & Security

TermDefinition
PASETOPlatform-Agnostic Security Tokens — used instead of JWT for session tokens (v4.local)
OAuth / OAuth2Open Authorization protocol for delegated access
ORCIDOpen Researcher and Contributor ID — persistent digital identifier for researchers
CILogonFederated identity provider for academic/research institutions
Academic verificationIdentity verification via CILogon institutional login, required for compute-intensive operations.
FernetSymmetric encryption scheme (used for encrypting federation passwords)
Argon2Memory-hard password hashing function
SOPSSecrets OPerationS — tool for encrypting YAML/JSON secrets files

Federation & Distributed Systems

TermDefinition
FederationDistributed queries across institutions while each retains control of its data. See Federation overview.
HubCentral SynDB node that coordinates federation
ClusterNamed remote ClickHouse instance registered with the hub
NodeIndividual federation member running ClickHouse and syndb-node; data stays on its infrastructure.
DelegationRouting a query to the remote cluster that owns the requested dataset
Locality indexMapping from dataset IDs to the cluster where they reside
libp2pPeer-to-peer networking library used for federation communication
Swarmlibp2p network of connected peers
DHTDistributed Hash Table — used for peer discovery and actor registration
mDNSMulticast DNS — local network service discovery
multiaddrlibp2p multi-address format encoding transport + address
piyingRust actor framework for async message-passing (a Kameo fork)
ActorAutonomous async agent in the piying system
ActorRef / RemoteActorRefHandle to a local or remote actor
papayaLock-free concurrent hash map library
Cluster healthStatus enum: Healthy, Degraded, Unreachable, Unknown
Schema syncProtocol for distributing ClickHouse DDL across federation clusters

S3 & Object Storage

TermDefinition
S3Amazon Simple Storage Service, or an S3-compatible service such as Ceph RGW
Presigned URLTemporary, time-limited URL granting direct S3 access
Rook CephKubernetes-native distributed storage (backs S3 in production)

S3 Buckets

BucketContents
syndb-mesh3D neuronal mesh/geometry files
syndb-swbSpatial Web Bundle data
syndb-searchSearch index data
syndb-jobsJob queue results and state

Type-safe Newtypes

Validated string wrappers used throughout the codebase:

TypeValidation Rule
EmailMust contain @
DoiMust start with 10.
CountryCodeISO 3166-1 alpha-2 (two uppercase letters)
ClusterNameNon-empty string
GroupNameNon-empty string
ScientistTagFormat prefix#NNNN (e.g., alice#0042)
DatabaseNameNon-empty string
DatasetLabelNon-empty human-readable dataset name
CollectionNameNon-empty dataset collection name

API & Web Framework

TermDefinition
AxumRust async web framework (HTTP API on port 8080)
tonicRust gRPC framework (Arrow Flight on port 50051)
gRPCGoogle Remote Procedure Call framework over HTTP/2
RESTRepresentational State Transfer
CORSCross-Origin Resource Sharing
OpenAPIAPI specification standard (generated via utoipa)
utoipaRust library for generating OpenAPI/Swagger documentation

Arrow Flight Operations

OperationPurpose
DoGetDownload data (streaming RecordBatches)
DoPutUpload data
DoActionExecute a named action (e.g., HEALTH, DELETE_DATASET, JOB_STATUS)
DoExchangeBidirectional streaming
FlightDescriptorRequest metadata identifying the resource
TicketOpaque token the client presents to retrieve data
RecordBatchArrow columnar data chunk

Job Queue

TermDefinition
JobAsynchronous query or graph-analysis task. See Jobs system.
Job statusLifecycle: Pending → Running → Completed / Failed / Cancelled
Job kindQuery (SQL) or GraphAnalysis
Query scopeLocal (hub only), Remote (single cluster), or Federation (multi-cluster)
Saved queryUser-persisted SQL template with name and description

Infrastructure & Tooling

TermDefinition
NixDeclarative, reproducible package manager and build system
FlakeNix flake — reproducible project environment definition
HelmKubernetes package manager for deploying charts
OpenTofu (tofu)Infrastructure-as-code tool (open-source Terraform fork)
NautilusNational Research Platform (NRP) Kubernetes cluster used for production
CHIClickHouseInstallation — Altinity operator custom resource for ClickHouse on K8s
SpiloZalando’s PostgreSQL high-availability container (runs with patroni + etcd)
cert-managerKubernetes add-on for automated TLS certificate provisioning

Rust Ecosystem

TermDefinition
CargoRust package manager and build tool
WorkspaceCargo workspace — monorepo containing multiple crates
CrateA Rust compilation unit / package
ClippyRust linter
nextestParallel Rust test runner (replaces cargo test)
taploTOML formatter and linter
SeaORMAsync Rust ORM for relational databases
FigmentConfiguration merging library (env + files + defaults)
SerdeRust serialization/deserialization framework
StrumDerive macros for enum ↔ string conversions
SecrecyZero-copy wrapper for secret values (prevents accidental logging)
petgraphGraph data structure and algorithm library
tokioAsync runtime for Rust
DioxusRust web framework used for the SynDB server-rendered UI
LTOLink-Time Optimization — compiler optimization across crate boundaries

Python Ecosystem

TermDefinition
FastAPIPython async web framework
PydanticPython data validation via type annotations
PolarsHigh-performance DataFrame library (alternative to pandas)
PyArrowPython bindings for Apache Arrow
httpxAsync Python HTTP client
WebDriverBrowser protocol used by the Rust end-to-end contract tests

Benchmarking

TermDefinition
Scale tierDataset size for benchmarks: 100k, 1M, 10M, 100M rows
Query modeExecution context: PreMerge, PostMerge, MaterializedView
Lab profileSimulated research lab with specific measurement biases and annotation completeness
Volume biasMultiplicative factor simulating measurement accuracy
Annotation completenessFraction (0.0–1.0) of objects detected in a dataset
CriterionRust micro-benchmarking harness

Serialization Formats

FormatDescription
JSONJavaScript Object Notation
YAMLYAML Ain’t Markup Language (config files)
TOMLTom’s Obvious Minimal Language (Cargo.toml, settings)
MessagePackCompact binary serialization
LZ4Fast compression algorithm
zstdZstandard compression (used by ClickHouse)

Common Environment Variables

VariablePurpose
DEV_MODEEnables development-mode defaults
TESTINGActivates test-mode configuration
REQUIRE_AUTHENTICATIONEnforces OAuth login
PASSLIB_SECRETPASETO token signing key
FERNET_KEYSFederation password encryption keys
FEDERATION_CLUSTER_NAMEThis node’s federation identity
FLIGHT_PORTArrow Flight gRPC port (default 50051)
S3_ENDPOINT_URLS3-compatible endpoint
S3_PUBLIC_ENDPOINT_URLPublicly accessible S3 endpoint
OA_{GITHUB,GOOGLE,ORCID,CILOGON}_ID/SECRETOAuth provider credentials