@cumulus/db 9.8.0 → 9.9.2

package/dist/config.d.ts

@@ -8,6 +8,7 @@ export declare const localStackConnectionEnv: {
     PG_DATABASE: string;
     PG_PORT: string;
 };
+export declare const isKnexDebugEnabled: (env?: NodeJS.ProcessEnv) => boolean;
 export declare const getSecretConnectionConfig: (SecretId: string, secretsManager: AWS.SecretsManager) => Promise<Knex.PgConnectionConfig>;
 export declare const getConnectionConfigEnv: (env: NodeJS.ProcessEnv) => Knex.PgConnectionConfig;
 /**

package/dist/config.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getKnexConfig = exports.getConnectionConfig = exports.getConnectionConfigEnv = exports.getSecretConnectionConfig = exports.localStackConnectionEnv = void 0;
+exports.getKnexConfig = exports.getConnectionConfig = exports.getConnectionConfigEnv = exports.getSecretConnectionConfig = exports.isKnexDebugEnabled = exports.localStackConnectionEnv = void 0;
 const aws_sdk_1 = __importDefault(require("aws-sdk"));
 const common_1 = require("@cumulus/common");
 exports.localStackConnectionEnv = {
@@ -13,6 +13,8 @@ exports.localStackConnectionEnv = {
     PG_DATABASE: 'postgres',
     PG_PORT: '5432',
 };
+const isKnexDebugEnabled = (env = {}) => env.KNEX_DEBUG === 'true';
+exports.isKnexDebugEnabled = isKnexDebugEnabled;
 const getSecretConnectionConfig = async (SecretId, secretsManager) => {
     var _a;
     const response = await secretsManager.getSecretValue({ SecretId }).promise();
@@ -110,7 +112,7 @@ const getKnexConfig = async ({ env = process.env, secretsManager = new aws_sdk_1
     const knexConfig = {
         client: 'pg',
         connection: await (0, exports.getConnectionConfig)({ env, secretsManager }),
-        debug: env.KNEX_DEBUG === 'true',
+        debug: (0, exports.isKnexDebugEnabled)(env),
         asyncStackTraces: env.KNEX_ASYNC_STACK_TRACES === 'true',
         pool: {
             min: 0,

package/dist/connection.js

@@ -44,16 +44,37 @@ const log = new logger_1.default({ sender: '@cumulus/db/connection' });
  * @returns {Promise<Knex>} a Knex configuration object that has returned at least one query
  */
 const getKnexClient = async ({ env = process.env, secretsManager = new aws_sdk_1.default.SecretsManager(), knexLogger = log, } = {}) => {
+    if ((0, config_1.isKnexDebugEnabled)(env)) {
+        knexLogger.info('Initializing connection pool...');
+    }
     const knexConfig = await (0, config_1.getKnexConfig)({ env, secretsManager });
     const knexClient = (0, knex_1.knex)(knexConfig);
-    //@ts-ignore
-    // context is an internal object that isn't typed
-    // this is needed to force tarn to log per-retry failures
-    // and allow propagateCreateError to be set `false`
-    knexClient.context.client.pool.on('createFail', (_, error) => {
-        knexLogger.warn('knex failed on attempted connection', error);
-        throw error;
-    });
+    if ((0, config_1.isKnexDebugEnabled)(env)) {
+        //@ts-ignore
+        // context is an internal object that isn't typed
+        // this is needed to force tarn to log per-retry failures
+        // and allow propagateCreateError to be set `false`
+        knexClient.context.client.pool.on('createFail', (_, error) => {
+            knexLogger.warn('knex failed on attempted connection', error);
+            throw error;
+        });
+        //@ts-ignore
+        knexClient.context.client.pool.on('createSuccess', (_, resource) => {
+            knexLogger.info(`added connection to pool: ${JSON.stringify(resource)}`);
+        });
+        //@ts-ignore
+        knexClient.context.client.pool.on('acquireSuccess', (_, resource) => {
+            knexLogger.info(`acquired connection from pool: ${JSON.stringify(resource)}`);
+        });
+        //@ts-ignore
+        knexClient.context.client.pool.on('release', (resource) => {
+            knexLogger.info(`released connection from pool: ${JSON.stringify(resource)}`);
+        });
+        //@ts-ignore
+        knexClient.context.client.pool.on('poolDestroySuccess', () => {
+            knexLogger.info('pool is destroyed');
+        });
+    }
     return knexClient;
 };
 exports.getKnexClient = getKnexClient;

package/dist/index.d.ts

@@ -15,14 +15,14 @@ export { PostgresGranule, PostgresGranuleRecord, } from './types/granule';
 export { PostgresPdr, PostgresPdrRecord, } from './types/pdr';
 export { PostgresFile, PostgresFileRecord, } from './types/file';
 export { translateApiAsyncOperationToPostgresAsyncOperation } from './translate/async_operations';
-export { translateApiFiletoPostgresFile, } from './translate/file';
+export { translateApiFiletoPostgresFile, translatePostgresFileToApiFile, } from './translate/file';
 export { translateApiCollectionToPostgresCollection } from './translate/collections';
 export { translateApiProviderToPostgresProvider, } from './translate/providers';
 export { translateApiRuleToPostgresRule } from './translate/rules';
 export { translateApiExecutionToPostgresExecution, translatePostgresExecutionToApiExecution, } from './translate/executions';
-export { translateApiGranuleToPostgresGranule } from './translate/granules';
+export { translateApiGranuleToPostgresGranule, translatePostgresGranuleToApiGranule, } from './translate/granules';
 export { translateApiPdrToPostgresPdr } from './translate/pdrs';
-export { executionArnsFromGranuleIdsAndWorkflowNames, newestExecutionArnFromGranuleIdWorkflowName, getWorkflowNameIntersectFromGranuleIds, } from './lib/execution';
+export { executionArnsFromGranuleIdsAndWorkflowNames, newestExecutionArnFromGranuleIdWorkflowName, getWorkflowNameIntersectFromGranuleIds, getApiExecutionCumulusIds, getApiGranuleExecutionCumulusIdsByExecution, getExecutionArnsByGranuleCumulusId, } from './lib/execution';
 export { getApiGranuleCumulusIds, getApiGranuleExecutionCumulusIds, upsertGranuleWithExecutionJoinRecord, } from './lib/granule';
 export { AsyncOperationPgModel } from './models/async_operation';
 export { BasePgModel } from './models/base';

package/dist/index.js

@@ -19,7 +19,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RulePgModel = exports.ProviderPgModel = exports.PdrPgModel = exports.GranulesExecutionsPgModel = exports.GranulePgModel = exports.FilePgModel = exports.ExecutionPgModel = exports.CollectionPgModel = exports.BasePgModel = exports.AsyncOperationPgModel = exports.upsertGranuleWithExecutionJoinRecord = exports.getApiGranuleExecutionCumulusIds = exports.getApiGranuleCumulusIds = exports.getWorkflowNameIntersectFromGranuleIds = exports.newestExecutionArnFromGranuleIdWorkflowName = exports.executionArnsFromGranuleIdsAndWorkflowNames = exports.translateApiPdrToPostgresPdr = exports.translateApiGranuleToPostgresGranule = exports.translatePostgresExecutionToApiExecution = exports.translateApiExecutionToPostgresExecution = exports.translateApiRuleToPostgresRule = exports.translateApiProviderToPostgresProvider = exports.translateApiCollectionToPostgresCollection = exports.translateApiFiletoPostgresFile = exports.translateApiAsyncOperationToPostgresAsyncOperation = exports.nullifyUndefinedProviderValues = exports.validateProviderHost = exports.migrationDir = exports.TableNames = exports.createRejectableTransaction = exports.localStackConnectionEnv = exports.getKnexConfig = exports.getKnexClient = exports.generateLocalTestDb = exports.fakeRuleRecordFactory = exports.fakeProviderRecordFactory = exports.fakePdrRecordFactory = exports.fakeGranuleRecordFactory = exports.fakeFileRecordFactory = exports.fakeExecutionRecordFactory = exports.fakeCollectionRecordFactory = exports.fakeAsyncOperationRecordFactory = exports.destroyLocalTestDb = exports.deleteTestDatabase = exports.createTestDatabase = exports.Knex = void 0;
+exports.ProviderPgModel = exports.PdrPgModel = exports.GranulesExecutionsPgModel = exports.GranulePgModel = exports.FilePgModel = exports.ExecutionPgModel = exports.CollectionPgModel = exports.BasePgModel = exports.AsyncOperationPgModel = exports.upsertGranuleWithExecutionJoinRecord = exports.getApiGranuleExecutionCumulusIds = exports.getApiGranuleCumulusIds = exports.getExecutionArnsByGranuleCumulusId = exports.getApiGranuleExecutionCumulusIdsByExecution = exports.getApiExecutionCumulusIds = exports.getWorkflowNameIntersectFromGranuleIds = exports.newestExecutionArnFromGranuleIdWorkflowName = exports.executionArnsFromGranuleIdsAndWorkflowNames = exports.translateApiPdrToPostgresPdr = exports.translatePostgresGranuleToApiGranule = exports.translateApiGranuleToPostgresGranule = exports.translatePostgresExecutionToApiExecution = exports.translateApiExecutionToPostgresExecution = exports.translateApiRuleToPostgresRule = exports.translateApiProviderToPostgresProvider = exports.translateApiCollectionToPostgresCollection = exports.translatePostgresFileToApiFile = exports.translateApiFiletoPostgresFile = exports.translateApiAsyncOperationToPostgresAsyncOperation = exports.nullifyUndefinedProviderValues = exports.validateProviderHost = exports.migrationDir = exports.TableNames = exports.createRejectableTransaction = exports.localStackConnectionEnv = exports.getKnexConfig = exports.getKnexClient = exports.generateLocalTestDb = exports.fakeRuleRecordFactory = exports.fakeProviderRecordFactory = exports.fakePdrRecordFactory = exports.fakeGranuleRecordFactory = exports.fakeFileRecordFactory = exports.fakeExecutionRecordFactory = exports.fakeCollectionRecordFactory = exports.fakeAsyncOperationRecordFactory = exports.destroyLocalTestDb = exports.deleteTestDatabase = exports.createTestDatabase = exports.Knex = void 0;
+exports.RulePgModel = void 0;
 const path = __importStar(require("path"));
 var knex_1 = require("knex");
 Object.defineProperty(exports, "Knex", { enumerable: true, get: function () { return knex_1.Knex; } });
@@ -53,6 +54,7 @@ var async_operations_1 = require("./translate/async_operations");
 Object.defineProperty(exports, "translateApiAsyncOperationToPostgresAsyncOperation", { enumerable: true, get: function () { return async_operations_1.translateApiAsyncOperationToPostgresAsyncOperation; } });
 var file_1 = require("./translate/file");
 Object.defineProperty(exports, "translateApiFiletoPostgresFile", { enumerable: true, get: function () { return file_1.translateApiFiletoPostgresFile; } });
+Object.defineProperty(exports, "translatePostgresFileToApiFile", { enumerable: true, get: function () { return file_1.translatePostgresFileToApiFile; } });
 var collections_1 = require("./translate/collections");
 Object.defineProperty(exports, "translateApiCollectionToPostgresCollection", { enumerable: true, get: function () { return collections_1.translateApiCollectionToPostgresCollection; } });
 var providers_1 = require("./translate/providers");
@@ -64,12 +66,16 @@ Object.defineProperty(exports, "translateApiExecutionToPostgresExecution", { enu
 Object.defineProperty(exports, "translatePostgresExecutionToApiExecution", { enumerable: true, get: function () { return executions_1.translatePostgresExecutionToApiExecution; } });
 var granules_1 = require("./translate/granules");
 Object.defineProperty(exports, "translateApiGranuleToPostgresGranule", { enumerable: true, get: function () { return granules_1.translateApiGranuleToPostgresGranule; } });
+Object.defineProperty(exports, "translatePostgresGranuleToApiGranule", { enumerable: true, get: function () { return granules_1.translatePostgresGranuleToApiGranule; } });
 var pdrs_1 = require("./translate/pdrs");
 Object.defineProperty(exports, "translateApiPdrToPostgresPdr", { enumerable: true, get: function () { return pdrs_1.translateApiPdrToPostgresPdr; } });
 var execution_1 = require("./lib/execution");
 Object.defineProperty(exports, "executionArnsFromGranuleIdsAndWorkflowNames", { enumerable: true, get: function () { return execution_1.executionArnsFromGranuleIdsAndWorkflowNames; } });
 Object.defineProperty(exports, "newestExecutionArnFromGranuleIdWorkflowName", { enumerable: true, get: function () { return execution_1.newestExecutionArnFromGranuleIdWorkflowName; } });
 Object.defineProperty(exports, "getWorkflowNameIntersectFromGranuleIds", { enumerable: true, get: function () { return execution_1.getWorkflowNameIntersectFromGranuleIds; } });
+Object.defineProperty(exports, "getApiExecutionCumulusIds", { enumerable: true, get: function () { return execution_1.getApiExecutionCumulusIds; } });
+Object.defineProperty(exports, "getApiGranuleExecutionCumulusIdsByExecution", { enumerable: true, get: function () { return execution_1.getApiGranuleExecutionCumulusIdsByExecution; } });
+Object.defineProperty(exports, "getExecutionArnsByGranuleCumulusId", { enumerable: true, get: function () { return execution_1.getExecutionArnsByGranuleCumulusId; } });
 var granule_1 = require("./lib/granule");
 Object.defineProperty(exports, "getApiGranuleCumulusIds", { enumerable: true, get: function () { return granule_1.getApiGranuleCumulusIds; } });
 Object.defineProperty(exports, "getApiGranuleExecutionCumulusIds", { enumerable: true, get: function () { return granule_1.getApiGranuleExecutionCumulusIds; } });

package/dist/lib/execution.d.ts

@@ -1,7 +1,20 @@
 import { Knex } from 'knex';
+import { ExecutionPgModel } from '../models/execution';
+import { GranulesExecutionsPgModel } from '../models/granules-executions';
 export interface ArnRecord {
     arn: string;
 }
+/**
+ * Returns a list of executionArns sorted by most recent first, for an input
+ * Granule Cumulus ID.
+ *
+ * @param {Knex | Knex.Transaction} knexOrTransaction
+ *   Knex client for reading from RDS database
+ * @param {number} granuleCumulusId - The primary ID for a Granule
+ * @param {number} limit - limit to number of executions to query
+ * @returns {Promise<ArnRecord[]>} - Array of arn objects with the most recent first.
+ */
+export declare const getExecutionArnsByGranuleCumulusId: (knexOrTransaction: Knex | Knex.Transaction, granuleCumulusId: Number, limit?: number | undefined) => Promise<ArnRecord[]>;
 /**
  * Returns a list of executionArns sorted by most recent first, for an input
  * list of granuleIds and workflowNames.
@@ -33,4 +46,29 @@ export declare const newestExecutionArnFromGranuleIdWorkflowName: (granuleId: st
  * @throws {RecordNotFound}
  */
 export declare const getWorkflowNameIntersectFromGranuleIds: (knexOrTransaction: Knex | Knex.Transaction, granuleCumulusIds: Array<number> | number) => Promise<Array<string>>;
+/**
+ * Get cumulus IDs for list of executions
+ *
+ * @param {Knex | Knex.Transaction} knexOrTransaction -
+ *  DB client or transaction
+ * @param {Array<Object>} executions - array of executions
+ * @param {Object} [executionPgModel] - Execution PG model class instance
+ * @returns {Promise<number[]>}
+ */
+export declare const getApiExecutionCumulusIds: (knexOrTransaction: Knex | Knex.Transaction, executions: Array<{
+    arn: string;
+}>, executionPgModel?: ExecutionPgModel) => Promise<number[]>;
+/**
+ * Get cumulus IDs for all granules associated to a set of executions
+ *
+ * @param {Knex | Knex.Transaction} knexOrTransaction -
+ *  DB client or transaction
+ * @param {Array<Object>} executions - array of executions
+ * @param {Object} [executionsPgModel]
+ *   Executions PG model class instance
+ * @returns {Promise<number[]>}
+ */
+export declare const getApiGranuleExecutionCumulusIdsByExecution: (knexOrTransaction: Knex | Knex.Transaction, executions: Array<{
+    arn: string;
+}>, executionPgModel?: ExecutionPgModel, granulesExecutionsPgModel?: GranulesExecutionsPgModel) => Promise<Array<number>>;
 //# sourceMappingURL=execution.d.ts.map

package/dist/lib/execution.js

@@ -1,11 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getWorkflowNameIntersectFromGranuleIds = exports.newestExecutionArnFromGranuleIdWorkflowName = exports.executionArnsFromGranuleIdsAndWorkflowNames = void 0;
+exports.getApiGranuleExecutionCumulusIdsByExecution = exports.getApiExecutionCumulusIds = exports.getWorkflowNameIntersectFromGranuleIds = exports.newestExecutionArnFromGranuleIdWorkflowName = exports.executionArnsFromGranuleIdsAndWorkflowNames = exports.getExecutionArnsByGranuleCumulusId = void 0;
 const errors_1 = require("@cumulus/errors");
+const execution_1 = require("../models/execution");
+const granules_executions_1 = require("../models/granules-executions");
 const tables_1 = require("../tables");
 const Logger = require('@cumulus/logger');
 const { getKnexClient } = require('../connection');
 const log = new Logger({ sender: '@cumulus/db/lib/execution' });
+/**
+ * Returns a list of executionArns sorted by most recent first, for an input
+ * Granule Cumulus ID.
+ *
+ * @param {Knex | Knex.Transaction} knexOrTransaction
+ *   Knex client for reading from RDS database
+ * @param {number} granuleCumulusId - The primary ID for a Granule
+ * @param {number} limit - limit to number of executions to query
+ * @returns {Promise<ArnRecord[]>} - Array of arn objects with the most recent first.
+ */
+const getExecutionArnsByGranuleCumulusId = async (knexOrTransaction, granuleCumulusId, limit) => {
+    const knexQuery = knexOrTransaction(tables_1.TableNames.executions)
+        .select(`${tables_1.TableNames.executions}.arn`)
+        .where(`${tables_1.TableNames.granules}.cumulus_id`, granuleCumulusId)
+        .join(tables_1.TableNames.granulesExecutions, `${tables_1.TableNames.executions}.cumulus_id`, `${tables_1.TableNames.granulesExecutions}.execution_cumulus_id`)
+        .join(tables_1.TableNames.granules, `${tables_1.TableNames.granules}.cumulus_id`, `${tables_1.TableNames.granulesExecutions}.granule_cumulus_id`)
+        .orderBy(`${tables_1.TableNames.executions}.timestamp`, 'desc');
+    if (limit) {
+        knexQuery.limit(limit);
+    }
+    return await knexQuery;
+};
+exports.getExecutionArnsByGranuleCumulusId = getExecutionArnsByGranuleCumulusId;
 /**
  * Returns a list of executionArns sorted by most recent first, for an input
  * list of granuleIds and workflowNames.
@@ -79,4 +104,37 @@ const getWorkflowNameIntersectFromGranuleIds = async (knexOrTransaction, granule
         .map((workflowCounts) => workflowCounts.workflow_name);
 };
 exports.getWorkflowNameIntersectFromGranuleIds = getWorkflowNameIntersectFromGranuleIds;
+/**
+ * Get cumulus IDs for list of executions
+ *
+ * @param {Knex | Knex.Transaction} knexOrTransaction -
+ *  DB client or transaction
+ * @param {Array<Object>} executions - array of executions
+ * @param {Object} [executionPgModel] - Execution PG model class instance
+ * @returns {Promise<number[]>}
+ */
+const getApiExecutionCumulusIds = async (knexOrTransaction, executions, executionPgModel = new execution_1.ExecutionPgModel()) => {
+    const executionCumulusIds = await Promise.all(executions.map(async (execution) => await executionPgModel.getRecordCumulusId(knexOrTransaction, {
+        arn: execution.arn,
+    })));
+    return [...new Set(executionCumulusIds)];
+};
+exports.getApiExecutionCumulusIds = getApiExecutionCumulusIds;
+/**
+ * Get cumulus IDs for all granules associated to a set of executions
+ *
+ * @param {Knex | Knex.Transaction} knexOrTransaction -
+ *  DB client or transaction
+ * @param {Array<Object>} executions - array of executions
+ * @param {Object} [executionsPgModel]
+ *   Executions PG model class instance
+ * @returns {Promise<number[]>}
+ */
+const getApiGranuleExecutionCumulusIdsByExecution = async (knexOrTransaction, executions, executionPgModel = new execution_1.ExecutionPgModel(), granulesExecutionsPgModel = new granules_executions_1.GranulesExecutionsPgModel()) => {
+    const executionCumulusIds = await (0, exports.getApiExecutionCumulusIds)(knexOrTransaction, executions, executionPgModel);
+    const granuleCumulusIds = await granulesExecutionsPgModel
+        .searchByExecutionCumulusIds(knexOrTransaction, executionCumulusIds);
+    return granuleCumulusIds;
+};
+exports.getApiGranuleExecutionCumulusIdsByExecution = getApiGranuleExecutionCumulusIdsByExecution;
 //# sourceMappingURL=execution.js.map

package/dist/migrations/20220126172008_files_granule_id_index.d.ts

@@ -0,0 +1,4 @@
+import { Knex } from 'knex';
+export declare const up: (knex: Knex) => Promise<void>;
+export declare const down: (knex: Knex) => Promise<void>;
+//# sourceMappingURL=20220126172008_files_granule_id_index.d.ts.map

package/dist/migrations/20220126172008_files_granule_id_index.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.down = exports.up = void 0;
+const up = async (knex) => {
+    await knex.schema.table('files', (table) => {
+        table.index('granule_cumulus_id');
+    });
+};
+exports.up = up;
+const down = async (knex) => {
+    await knex.schema.table('files', (table) => {
+        table.dropIndex('granule_cumulus_id');
+    });
+};
+exports.down = down;
+//# sourceMappingURL=20220126172008_files_granule_id_index.js.map

package/dist/models/base.d.ts

@@ -22,7 +22,7 @@ declare class BasePgModel<ItemType, RecordType extends {
      * Fetches multiple items from Postgres
      *
      * @param {Knex | Knex.Transaction} knexOrTransaction - DB client or transaction
-     * @param {Partial<RecordType>} params - An object or any portion of an object of type RecordType
+     * @param {Object} params - An object or any portion of an object of type RecordType
      * @returns {Promise<RecordType[]>} List of returned records
      */
     search(knexOrTransaction: Knex | Knex.Transaction, params: Partial<RecordType>): Promise<RecordType[]>;
@@ -41,7 +41,7 @@ declare class BasePgModel<ItemType, RecordType extends {
      *
      * @param {Knex | Knex.Transaction} knexOrTransaction -
      *  DB client or transaction
-     * @param {Array<keyof RecordType>} columnNames - column names for whereIn query
+     * @param {Array<string>} columnNames - column names for whereIn query
      * @param {Array<string>} values - record values for whereIn query
      * @returns {Promise<Array<number>>} An array of cumulus_ids for the returned records
      */

package/dist/models/base.js

@@ -40,7 +40,7 @@ class BasePgModel {
      * Fetches multiple items from Postgres
      *
      * @param {Knex | Knex.Transaction} knexOrTransaction - DB client or transaction
-     * @param {Partial<RecordType>} params - An object or any portion of an object of type RecordType
+     * @param {Object} params - An object or any portion of an object of type RecordType
      * @returns {Promise<RecordType[]>} List of returned records
      */
     async search(knexOrTransaction, params) {
@@ -72,7 +72,7 @@ class BasePgModel {
      *
      * @param {Knex | Knex.Transaction} knexOrTransaction -
      *  DB client or transaction
-     * @param {Array<keyof RecordType>} columnNames - column names for whereIn query
+     * @param {Array<string>} columnNames - column names for whereIn query
      * @param {Array<string>} values - record values for whereIn query
      * @returns {Promise<Array<number>>} An array of cumulus_ids for the returned records
      */

package/dist/models/granule.d.ts

@@ -36,6 +36,22 @@ export default class GranulePgModel extends BasePgModel<PostgresGranule, Postgre
      */
     get(knexOrTransaction: Knex | Knex.Transaction, params: PostgresGranuleUniqueColumns | RecordSelect): Promise<PostgresGranuleRecord>;
     upsert(knexOrTrx: Knex | Knex.Transaction, granule: PostgresGranule, executionCumulusId?: number, granulesExecutionsPgModel?: GranulesExecutionsPgModel): Promise<any[]>;
+    /**
+     * Get granules from the granule cumulus_id
+     *
+     * @param {Knex | Knex.Transaction} knexOrTrx -
+     *  DB client or transaction
+     * @param {Array<number>} granuleCumulusIds -
+     * single granule cumulus_id or array of granule cumulus_ids
+     * @param {Object} [params] - Optional object with addition params for query
+     * @param {number} [params.limit] - number of records to be returned
+     * @param {number} [params.offset] - record offset
+     * @returns {Promise<Array<PostgresGranuleRecord>>} An array of granules
+     */
+    searchByCumulusIds(knexOrTrx: Knex | Knex.Transaction, granuleCumulusIds: Array<number> | number, params: {
+        limit: number;
+        offset: number;
+    }): Promise<Array<PostgresGranuleRecord>>;
 }
 export { GranulePgModel };
 //# sourceMappingURL=granule.d.ts.map

package/dist/models/granule.js

@@ -6,6 +6,7 @@ const tables_1 = require("../tables");
 const base_1 = require("./base");
 const granules_executions_1 = require("./granules-executions");
 const timestamp_1 = require("../lib/timestamp");
+const sort_1 = require("../lib/sort");
 function isRecordSelect(param) {
     return param.cumulus_id !== undefined;
 }
@@ -97,6 +98,39 @@ class GranulePgModel extends base_1.BasePgModel {
             .where(knexOrTrx.raw(`${this.tableName}.created_at <= to_timestamp(${(0, timestamp_1.translateDateToUTC)(granule.created_at)})`))
             .returning('cumulus_id');
     }
+    /**
+     * Get granules from the granule cumulus_id
+     *
+     * @param {Knex | Knex.Transaction} knexOrTrx -
+     *  DB client or transaction
+     * @param {Array<number>} granuleCumulusIds -
+     * single granule cumulus_id or array of granule cumulus_ids
+     * @param {Object} [params] - Optional object with addition params for query
+     * @param {number} [params.limit] - number of records to be returned
+     * @param {number} [params.offset] - record offset
+     * @returns {Promise<Array<PostgresGranuleRecord>>} An array of granules
+     */
+    async searchByCumulusIds(knexOrTrx, granuleCumulusIds, params) {
+        const { limit, offset, ...sortQueries } = params || {};
+        const sortFields = (0, sort_1.getSortFields)(sortQueries);
+        const granuleCumulusIdsArray = [granuleCumulusIds].flat();
+        const granules = await knexOrTrx(this.tableName)
+            .whereIn('cumulus_id', granuleCumulusIdsArray)
+            .modify((queryBuilder) => {
+            if (limit)
+                queryBuilder.limit(limit);
+            if (offset)
+                queryBuilder.offset(offset);
+            if (sortFields.length >= 1) {
+                sortFields.forEach((sortObject) => {
+                    const sortField = Object.keys(sortObject)[0];
+                    const { order } = sortObject[sortField];
+                    queryBuilder.orderBy(sortField, order);
+                });
+            }
+        });
+        return granules;
+    }
 }
 exports.default = GranulePgModel;
 exports.GranulePgModel = GranulePgModel;

package/dist/models/granules-executions.d.ts

@@ -17,6 +17,16 @@ export default class GranulesExecutionsPgModel {
      * @returns {Promise<Array<number>>} An array of execution_cumulus_ids
      */
     searchByGranuleCumulusIds(knexOrTransaction: Knex | Knex.Transaction, granuleCumulusIds: Array<number> | number): Promise<Array<number>>;
+    /**
+     * Get granule_cumulus_id column values from the execution_cumulus_id
+     *
+     * @param {Knex | Knex.Transaction} knexOrTransaction -
+     *  DB client or transaction
+     * @param {number | Array<number>} executionCumulusIds -
+     * single execution_cumulus_id or array of execution_cumulus_ids
+     * @returns {Promise<Array<number>>} An array of granule_cumulus_ids
+     */
+    searchByExecutionCumulusIds(knexOrTransaction: Knex | Knex.Transaction, executionCumulusIds: Array<number> | number): Promise<Array<number>>;
     delete(knexTransaction: Knex.Transaction, params: Partial<PostgresGranuleExecution>): Promise<number>;
     search(knexTransaction: Knex | Knex.Transaction, query: Partial<PostgresGranuleExecution>): Knex.QueryBuilder<PostgresGranuleExecution, {
         _base: PostgresGranuleExecution;

package/dist/models/granules-executions.js

@@ -38,6 +38,23 @@ class GranulesExecutionsPgModel {
             .groupBy('execution_cumulus_id');
         return granuleExecutions.map((granuleExecution) => granuleExecution.execution_cumulus_id);
     }
+    /**
+     * Get granule_cumulus_id column values from the execution_cumulus_id
+     *
+     * @param {Knex | Knex.Transaction} knexOrTransaction -
+     *  DB client or transaction
+     * @param {number | Array<number>} executionCumulusIds -
+     * single execution_cumulus_id or array of execution_cumulus_ids
+     * @returns {Promise<Array<number>>} An array of granule_cumulus_ids
+     */
+    async searchByExecutionCumulusIds(knexOrTransaction, executionCumulusIds) {
+        const executionCumulusIdsArray = [executionCumulusIds].flat();
+        const granuleExecutions = await knexOrTransaction(this.tableName)
+            .select('granule_cumulus_id')
+            .whereIn('execution_cumulus_id', executionCumulusIdsArray)
+            .groupBy('granule_cumulus_id');
+        return granuleExecutions.map((granuleExecution) => granuleExecution.granule_cumulus_id);
+    }
     async delete(knexTransaction, params) {
         return await knexTransaction(this.tableName)
             .where(params)

package/dist/translate/file.d.ts

@@ -1,4 +1,5 @@
 import { ApiFile } from '@cumulus/types/api/files';
-import { PostgresFile } from '../types/file';
+import { PostgresFile, PostgresFileRecord } from '../types/file';
+export declare const translatePostgresFileToApiFile: (filePgRecord: PostgresFileRecord) => Omit<ApiFile, 'granuleId'>;
 export declare const translateApiFiletoPostgresFile: (file: ApiFile) => Omit<PostgresFile, 'granule_cumulus_id'>;
 //# sourceMappingURL=file.d.ts.map

package/dist/translate/file.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.translateApiFiletoPostgresFile = void 0;
+exports.translateApiFiletoPostgresFile = exports.translatePostgresFileToApiFile = void 0;
 const { parseS3Uri } = require('@cumulus/aws-client/S3');
+const { removeNilProperties } = require('@cumulus/common/util');
 const getBucket = (file) => {
     if (file.bucket)
         return file.bucket;
@@ -16,6 +17,16 @@ const getKey = (file) => {
         return parseS3Uri(file.filename).Key;
     return undefined;
 };
+const translatePostgresFileToApiFile = (filePgRecord) => removeNilProperties({
+    bucket: filePgRecord.bucket,
+    checksum: filePgRecord.checksum_value,
+    checksumType: filePgRecord.checksum_type,
+    fileName: filePgRecord.file_name,
+    key: filePgRecord.key,
+    size: filePgRecord.file_size ? filePgRecord.file_size : undefined,
+    source: filePgRecord.source,
+});
+exports.translatePostgresFileToApiFile = translatePostgresFileToApiFile;
 const translateApiFiletoPostgresFile = (file) => {
     const bucket = getBucket(file);
     const key = getKey(file);

package/dist/translate/granules.d.ts

@@ -1,8 +1,34 @@
 import { Knex } from 'knex';
+import { ApiGranule } from '@cumulus/types/api/granules';
 import { CollectionPgModel } from '../models/collection';
 import { PdrPgModel } from '../models/pdr';
-import { PostgresGranule } from '../types/granule';
+import { PostgresGranule, PostgresGranuleRecord } from '../types/granule';
 import { ProviderPgModel } from '../models/provider';
+import { FilePgModel } from '../models/file';
+import { PostgresCollectionRecord } from '../types/collection';
+/**
+ * Generate an API Granule object from a Postgres Granule with associated Files.
+ *
+ * @param {Object} params
+ * @param {PostgresGranuleRecord} params.granulePgRecord - Granule from Postgres
+ * @param {PostgresCollectionRecord} params.collectionPgRecord - Collection from Postgres
+ * @param {Knex | Knex.Transaction} params.knexOrTransaction
+ *   Knex client for reading from RDS database
+ * @param {Object} [params.collectionPgModel] - Instance of the collection database model
+ * @param {Object} [params.pdrPgModel] - Instance of the pdr database model
+ * @param {Object} [params.providerPgModel] - Instance of the provider database model
+ * @param {Object} [params.filePgModel] - Instance of the file database model
+ * @returns {Object} An API Granule with associated Files
+ */
+export declare const translatePostgresGranuleToApiGranule: ({ granulePgRecord, collectionPgRecord, knexOrTransaction, collectionPgModel, pdrPgModel, providerPgModel, filePgModel, }: {
+    granulePgRecord: PostgresGranuleRecord;
+    collectionPgRecord: PostgresCollectionRecord;
+    knexOrTransaction: Knex | Knex.Transaction;
+    collectionPgModel?: CollectionPgModel | undefined;
+    pdrPgModel?: PdrPgModel | undefined;
+    providerPgModel?: ProviderPgModel | undefined;
+    filePgModel?: FilePgModel | undefined;
+}) => Promise<ApiGranule>;
 /**
  * Generate a Postgres granule record from a DynamoDB record.
  *

package/dist/translate/granules.js

@@ -1,10 +1,78 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.translateApiGranuleToPostgresGranule = void 0;
+exports.translateApiGranuleToPostgresGranule = exports.translatePostgresGranuleToApiGranule = void 0;
+const Collections_1 = require("@cumulus/message/Collections");
+const Executions_1 = require("@cumulus/message/Executions");
+const util_1 = require("@cumulus/common/util");
+const errors_1 = require("@cumulus/errors");
 const collection_1 = require("../models/collection");
 const pdr_1 = require("../models/pdr");
 const provider_1 = require("../models/provider");
-const { deconstructCollectionId } = require('@cumulus/message/Collections');
+const file_1 = require("../models/file");
+const file_2 = require("./file");
+const execution_1 = require("../lib/execution");
+/**
+ * Generate an API Granule object from a Postgres Granule with associated Files.
+ *
+ * @param {Object} params
+ * @param {PostgresGranuleRecord} params.granulePgRecord - Granule from Postgres
+ * @param {PostgresCollectionRecord} params.collectionPgRecord - Collection from Postgres
+ * @param {Knex | Knex.Transaction} params.knexOrTransaction
+ *   Knex client for reading from RDS database
+ * @param {Object} [params.collectionPgModel] - Instance of the collection database model
+ * @param {Object} [params.pdrPgModel] - Instance of the pdr database model
+ * @param {Object} [params.providerPgModel] - Instance of the provider database model
+ * @param {Object} [params.filePgModel] - Instance of the file database model
+ * @returns {Object} An API Granule with associated Files
+ */
+const translatePostgresGranuleToApiGranule = async ({ granulePgRecord, collectionPgRecord, knexOrTransaction, collectionPgModel = new collection_1.CollectionPgModel(), pdrPgModel = new pdr_1.PdrPgModel(), providerPgModel = new provider_1.ProviderPgModel(), filePgModel = new file_1.FilePgModel(), }) => {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+    const collection = collectionPgRecord || await collectionPgModel.get(knexOrTransaction, { cumulus_id: granulePgRecord.collection_cumulus_id });
+    if (granulePgRecord.collection_cumulus_id !== collection.cumulus_id) {
+        throw new errors_1.ValidationError(`Collection ${collection.cumulus_id} does not match the Granule's Collection ${granulePgRecord.collection_cumulus_id}`);
+    }
+    const files = await filePgModel.search(knexOrTransaction, { granule_cumulus_id: granulePgRecord.cumulus_id });
+    const executionArns = await (0, execution_1.getExecutionArnsByGranuleCumulusId)(knexOrTransaction, granulePgRecord.cumulus_id, 1);
+    let pdr;
+    if (granulePgRecord.pdr_cumulus_id) {
+        pdr = await pdrPgModel.get(knexOrTransaction, { cumulus_id: granulePgRecord.pdr_cumulus_id });
+    }
+    let provider;
+    if (granulePgRecord.provider_cumulus_id) {
+        provider = await providerPgModel.get(knexOrTransaction, { cumulus_id: granulePgRecord.provider_cumulus_id });
+    }
+    const apiGranule = (0, util_1.removeNilProperties)({
+        beginningDateTime: (_a = granulePgRecord.beginning_date_time) === null || _a === void 0 ? void 0 : _a.toISOString(),
+        cmrLink: granulePgRecord.cmr_link,
+        collectionId: (0, Collections_1.constructCollectionId)(collection.name, collection.version),
+        createdAt: (_b = granulePgRecord.created_at) === null || _b === void 0 ? void 0 : _b.getTime(),
+        duration: granulePgRecord.duration,
+        endingDateTime: (_c = granulePgRecord.ending_date_time) === null || _c === void 0 ? void 0 : _c.toISOString(),
+        error: granulePgRecord.error,
+        execution: executionArns[0] ? (0, Executions_1.getExecutionUrlFromArn)(executionArns[0].arn) : undefined,
+        files: files.map((file) => ({
+            ...(0, file_2.translatePostgresFileToApiFile)(file),
+        })),
+        granuleId: granulePgRecord.granule_id,
+        lastUpdateDateTime: (_d = granulePgRecord.last_update_date_time) === null || _d === void 0 ? void 0 : _d.toISOString(),
+        pdrName: pdr ? pdr.name : undefined,
+        processingEndDateTime: (_e = granulePgRecord.processing_end_date_time) === null || _e === void 0 ? void 0 : _e.toISOString(),
+        processingStartDateTime: (_f = granulePgRecord.processing_start_date_time) === null || _f === void 0 ? void 0 : _f.toISOString(),
+        productionDateTime: (_g = granulePgRecord.production_date_time) === null || _g === void 0 ? void 0 : _g.toISOString(),
+        productVolume: granulePgRecord.product_volume
+            ? granulePgRecord.product_volume : undefined,
+        provider: provider ? provider.name : undefined,
+        published: granulePgRecord.published,
+        queryFields: granulePgRecord.query_fields,
+        status: granulePgRecord.status,
+        timestamp: (_h = granulePgRecord.timestamp) === null || _h === void 0 ? void 0 : _h.getTime(),
+        timeToArchive: granulePgRecord.time_to_archive,
+        timeToPreprocess: granulePgRecord.time_to_process,
+        updatedAt: (_j = granulePgRecord.updated_at) === null || _j === void 0 ? void 0 : _j.getTime(),
+    });
+    return apiGranule;
+};
+exports.translatePostgresGranuleToApiGranule = translatePostgresGranuleToApiGranule;
 /**
  * Generate a Postgres granule record from a DynamoDB record.
  *
@@ -18,7 +86,7 @@ const { deconstructCollectionId } = require('@cumulus/message/Collections');
  * @returns {Object} A granule PG record
  */
 const translateApiGranuleToPostgresGranule = async (dynamoRecord, knexOrTransaction, collectionPgModel = new collection_1.CollectionPgModel(), pdrPgModel = new pdr_1.PdrPgModel(), providerPgModel = new provider_1.ProviderPgModel()) => {
-    const { name, version } = deconstructCollectionId(dynamoRecord.collectionId);
+    const { name, version } = (0, Collections_1.deconstructCollectionId)(dynamoRecord.collectionId);
     const granuleRecord = {
         granule_id: dynamoRecord.granuleId,
         status: dynamoRecord.status,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cumulus/db",
-  "version": "9.8.0",
+  "version": "9.9.2",
   "description": "Utilities for working with the Cumulus DB",
   "license": "Apache-2.0",
   "main": "./dist/index.js",
@@ -29,22 +29,22 @@
     "node": ">=12.18.0"
   },
   "dependencies": {
-    "@cumulus/aws-client": "9.8.0",
-    "@cumulus/common": "9.8.0",
-    "@cumulus/errors": "9.8.0",
-    "@cumulus/logger": "9.8.0",
-    "@cumulus/message": "9.8.0",
-    "@cumulus/types": "9.8.0",
+    "@cumulus/aws-client": "9.9.2",
+    "@cumulus/common": "9.9.2",
+    "@cumulus/errors": "9.9.2",
+    "@cumulus/logger": "9.9.2",
+    "@cumulus/message": "9.9.2",
+    "@cumulus/types": "9.9.2",
     "crypto-random-string": "^3.2.0",
     "is-valid-hostname": "0.0.1",
     "knex": "0.95.11",
     "lodash": "^4.17.20",
     "pg": "^8.3.0",
     "snake-camel": "^1.0.6",
-    "uuid": "8.3.1"
+    "uuid": "8.3.2"
   },
   "devDependencies": {
     "@types/uuid": "^8.0.0"
   },
-  "gitHead": "913034ba6814e562b7f3d58bb39cf086255a6efd"
+  "gitHead": "0bfe94a0c4919567a35fc8bcff24643ba84a6547"
 }