project-info.ts

/*
 *  This file is part of CoCalc: Copyright © 2020 Sagemath, Inc.
 *  License: MS-RSL – see LICENSE.md for details
 */

/*
This table contains real-time information about a running project. In particular, this includes the running processes, CGroup status, etc. It is updated frequently, hence use it wisely...
*/

import { Table } from "./types";

Table({
  name: "project_info",
  fields: {
    project_id: {
      type: "uuid",
      desc: "The project id.",
    },
    info: {
      // change this according to all the usual schema rules
      type: "map",
      pg_type: "JSONB[]",
      desc: "Info about the project",
    },
  },
  rules: {
    durability: "ephemeral", // won't be stored in the database at all ever.
    desc:
      "Information about running processes, cgroups, disk space, etc. of projects",
    primary_key: ["project_id"], // can list multiple another field if you want to have multiple records for a project.
    user_query: {
      get: {
        pg_where: ["projects"],
        fields: {
          project_id: null,
          info: null,
        },
      },
      set: {
        // users can set that they are interested in this
        fields: {
          project_id: "project_id",
          info: true,
        },
      },
    },

    project_query: {
      get: {
        pg_where: [{ "project_id = $::UUID": "project_id" }],
        fields: {
          project_id: null,
          info: null,
        },
      },
      set: {
        // delete=true, since project *IS* allowed to delete entries
        delete: true,
        fields: {
          project_id: "project_id",
          info: true,
        },
      },
    },
  },
});