Measurement Data Store Python API

Introduction

About

The ni.datastore Python package provides APIs for publishing and retrieving data from the NI Measurement Data Store

NI created and supports this package.

Operating System Support

ni.datastore supports Windows and Linux operating systems.

Python Version Support

ni.datastore supports CPython 3.10+.

Installation

As a prerequisite to using the ni.datastore module, you must install Measurement Data Services Software 2026 Q1 or later on your system. You can download and install this software using NI Package Manager.

You can directly install the ni.datastore package using pip or by listing it as a dependency in your project’s pyproject.toml file.

Table of Contents

• Reference Guide
  • NI Data Store
    • Core Entities
      • TestResult
      • Step
      • PublishedMeasurement
      • PublishedCondition
      • Supporting Types
    • The Hierarchy
    • Data Access Patterns
  • NI Metadata Store
    • Core Entities
      • Operator
    • Test Station
    • UUT (Unit Under Test)
    • UUT Instance
    • Hardware Item
    • Software Item
    • Test Description
    • Test
    • Test Adapter
    • Extension Schema
    • Alias
    • The Metadata Store Hierarchy
    • Custom Schemas and Extensions
      • How Extensions Work
      • Schema Validation
      • Schema Example
      • Using Schemas in Practice
      • Benefits of Schema Validation
      • Schema Inheritance
    • Benefits of the Digital Thread
    • Extensibility
  • Using Measurement Data Services
    • Complete Workflow Overview
    • Required Imports
    • Setup Phase
      • 1. Create Core Metadata Entities
      • 2. Define Products Under Test
      • 3. Define Test Procedures
      • 4. Register Extension Schemas (Optional)
      • 5. Create Aliases (Optional)
    • Test Execution Phase
      • 1. Create Test Result Session
      • 2. Create Test Steps
      • 3. Publish Test Conditions
      • 4. Publish Measurements
    • Analysis Phase
      • 1. Query Measurements
      • 2. Query Test Context
      • 3. Retrieve Measurement Data
      • 4. Cross-Reference with Metadata
      • 5. Advanced Analysis Examples
    • Best Practices
      • Metadata Management
      • Test Execution
      • Data Organization
      • Querying and Analysis
    • Integration Patterns
      • Automated Test Systems
      • Batch Processing
• Examples
  • OData Query Example Notebooks
  • Other Example Notebooks
  • Getting Started with Notebooks
  • Python Example Scripts
• API Reference
• ni.datastore
  • Submodules
    • ni.datastore.data
      • Classes
      • Package Contents
    • ni.datastore.metadata
      • Classes
      • Package Contents

Indices and tables

• Index

• Module Index

• Search Page