npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@umlss/filesystem-timeseries-db

v0.0.12

Published

A simple wrapper to set/get time-series data from a file system that is at least NFS v3 compatible

Downloads

16

Readme

file-system-time-series-database

This module allows using a file system as a time series database. It is efficient for these queries:

  • Get a range of data for an identifier (such as a user id)
  • Get the most recent time for an identifer (such as a user id)
  • Get the earliest time for an identifer (such as a user id)

The number of files in a directory is attempting to be limited to 768, though this may be exceeded occasionally. NFS allows 65535.

File System Format

The data is laid out in the following format, which shards the data by month:

/year/group1/group2/8ofid/8ofid/8ofid/id/year-month-day.extension

For example, for user deadbeef with a JSON file, group1 garmin, group2 sleeps:

/2020/garmin/sleeps/de/ad/be/deadbeef/2020-08-09.json

this will support billions of users with ease, provided the user ID has sufficient randomness.

Performance

Performance Assumptions.

The file system is assumed to have about 10mS of latency or less.

Parallelism

Operations are meant to be parallized, so for example if you are looking for the latest data the year direcotry would be queried for existence in parallel from the start epoch (2020) to today's current date, using Promise.map() to parallalize.

Usage

This package was developed to work with AWS's EFS on Lambda, though the file system handle is passed into this library so it doesn't really care.

Module Usage

  1. Add Module:

     npm install --save filesystem-timeseries-db
  2. Require Statement:

     const FsTimeSeriesDB = require('filesystem-timeseries-db');
  3. General usage:

     const fileSystem = fileHandle;
     const dbInstance = Object.create(FsTimeSeriesDB).setOptions({rootPath: rootPath});

Testing

Interactive Testing

  1. Run Docker Compose:

     docker-compose run app  /bin/bash
  2. Navigate to the directory where the source code is located:

     cd /home/code       
  3. Run NPM install

     npm install
        
  4. Run the unit tests

     npm test test/*.js