@cumulus/db 10.1.0 → 10.1.1-alpha.0

package/dist/config.d.ts

@@ -8,7 +8,6 @@ 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.isKnexDebugEnabled = exports.localStackConnectionEnv = void 0;
+exports.getKnexConfig = exports.getConnectionConfig = exports.getConnectionConfigEnv = exports.getSecretConnectionConfig = exports.localStackConnectionEnv = void 0;
 const aws_sdk_1 = __importDefault(require("aws-sdk"));
 const common_1 = require("@cumulus/common");
 exports.localStackConnectionEnv = {
@@ -13,8 +13,6 @@ 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();
@@ -112,7 +110,7 @@ const getKnexConfig = async ({ env = process.env, secretsManager = new aws_sdk_1
     const knexConfig = {
         client: 'pg',
         connection: await (0, exports.getConnectionConfig)({ env, secretsManager }),
-        debug: (0, exports.isKnexDebugEnabled)(env),
+        debug: env.KNEX_DEBUG === 'true',
         asyncStackTraces: env.KNEX_ASYNC_STACK_TRACES === 'true',
         pool: {
             min: 0,

package/dist/connection.js

@@ -44,37 +44,16 @@ 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);
-    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');
-        });
-    }
+    //@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;
+    });
     return knexClient;
 };
 exports.getKnexClient = getKnexClient;

package/dist/index.d.ts

@@ -1,11 +1,13 @@
 export { Knex } from 'knex';
 export { createTestDatabase, deleteTestDatabase, destroyLocalTestDb, fakeAsyncOperationRecordFactory, fakeCollectionRecordFactory, fakeExecutionRecordFactory, fakeFileRecordFactory, fakeGranuleRecordFactory, fakePdrRecordFactory, fakeProviderRecordFactory, fakeRuleRecordFactory, generateLocalTestDb, } from './test-utils';
+export { isCollisionError } from './lib/errors';
 export { getKnexClient } from './connection';
 export { getKnexConfig, localStackConnectionEnv } from './config';
 export { createRejectableTransaction } from './database';
 export { TableNames } from './tables';
 export declare const migrationDir: string;
 export { validateProviderHost, nullifyUndefinedProviderValues, } from './provider';
+export { BaseRecord, } from './types/base';
 export { PostgresAsyncOperation, PostgresAsyncOperationRecord, } from './types/async_operation';
 export { PostgresCollection, PostgresCollectionRecord, } from './types/collection';
 export { PostgresExecution, PostgresExecutionRecord, } from './types/execution';
@@ -14,16 +16,19 @@ export { PostgresRule, PostgresRuleRecord, } from './types/rule';
 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 { translateApiAsyncOperationToPostgresAsyncOperation, translatePostgresAsyncOperationToApiAsyncOperation, } from './translate/async_operations';
 export { translateApiFiletoPostgresFile, translatePostgresFileToApiFile, } from './translate/file';
-export { translateApiCollectionToPostgresCollection } from './translate/collections';
-export { translateApiProviderToPostgresProvider, } from './translate/providers';
-export { translateApiRuleToPostgresRule } from './translate/rules';
+export { translateApiCollectionToPostgresCollection, translatePostgresCollectionToApiCollection, } from './translate/collections';
+export { translateApiProviderToPostgresProvider, translatePostgresProviderToApiProvider, } from './translate/providers';
+export { translateApiRuleToPostgresRule, translatePostgresRuleToApiRule, } from './translate/rules';
 export { translateApiExecutionToPostgresExecution, translatePostgresExecutionToApiExecution, } from './translate/executions';
-export { translateApiGranuleToPostgresGranule, translatePostgresGranuleToApiGranule, } from './translate/granules';
-export { translateApiPdrToPostgresPdr } from './translate/pdrs';
-export { executionArnsFromGranuleIdsAndWorkflowNames, newestExecutionArnFromGranuleIdWorkflowName, getWorkflowNameIntersectFromGranuleIds, getApiExecutionCumulusIds, getApiGranuleExecutionCumulusIdsByExecution, getExecutionArnsByGranuleCumulusId, } from './lib/execution';
-export { getApiGranuleCumulusIds, getApiGranuleExecutionCumulusIds, upsertGranuleWithExecutionJoinRecord, } from './lib/granule';
+export { translateApiGranuleToPostgresGranule, translatePostgresGranuleToApiGranule, translatePostgresGranuleResultToApiGranule, } from './translate/granules';
+export { translateApiPdrToPostgresPdr, translatePostgresPdrToApiPdr, } from './translate/pdr';
+export { getCollectionsByGranuleIds, } from './lib/collection';
+export { executionArnsFromGranuleIdsAndWorkflowNames, newestExecutionArnFromGranuleIdWorkflowName, getWorkflowNameIntersectFromGranuleIds, getApiExecutionCumulusIds, getApiGranuleExecutionCumulusIdsByExecution, getExecutionInfoByGranuleCumulusId, } from './lib/execution';
+export { getFilesAndGranuleInfoQuery, } from './lib/file';
+export { getApiGranuleCumulusIds, getApiGranuleExecutionCumulusIds, getGranuleCollectionId, getUniqueGranuleByGranuleId, upsertGranuleWithExecutionJoinRecord, getGranulesByApiPropertiesQuery, } from './lib/granule';
+export { QuerySearchClient, } from './lib/QuerySearchClient';
 export { AsyncOperationPgModel } from './models/async_operation';
 export { BasePgModel } from './models/base';
 export { CollectionPgModel } from './models/collection';

package/dist/index.js

@@ -19,8 +19,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+exports.getGranuleCollectionId = exports.getApiGranuleExecutionCumulusIds = exports.getApiGranuleCumulusIds = exports.getFilesAndGranuleInfoQuery = exports.getExecutionInfoByGranuleCumulusId = exports.getApiGranuleExecutionCumulusIdsByExecution = exports.getApiExecutionCumulusIds = exports.getWorkflowNameIntersectFromGranuleIds = exports.newestExecutionArnFromGranuleIdWorkflowName = exports.executionArnsFromGranuleIdsAndWorkflowNames = exports.getCollectionsByGranuleIds = exports.translatePostgresPdrToApiPdr = exports.translateApiPdrToPostgresPdr = exports.translatePostgresGranuleResultToApiGranule = exports.translatePostgresGranuleToApiGranule = exports.translateApiGranuleToPostgresGranule = exports.translatePostgresExecutionToApiExecution = exports.translateApiExecutionToPostgresExecution = exports.translatePostgresRuleToApiRule = exports.translateApiRuleToPostgresRule = exports.translatePostgresProviderToApiProvider = exports.translateApiProviderToPostgresProvider = exports.translatePostgresCollectionToApiCollection = exports.translateApiCollectionToPostgresCollection = exports.translatePostgresFileToApiFile = exports.translateApiFiletoPostgresFile = exports.translatePostgresAsyncOperationToApiAsyncOperation = exports.translateApiAsyncOperationToPostgresAsyncOperation = exports.nullifyUndefinedProviderValues = exports.validateProviderHost = exports.migrationDir = exports.TableNames = exports.createRejectableTransaction = exports.localStackConnectionEnv = exports.getKnexConfig = exports.getKnexClient = exports.isCollisionError = 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 = exports.ProviderPgModel = exports.PdrPgModel = exports.GranulesExecutionsPgModel = exports.GranulePgModel = exports.FilePgModel = exports.ExecutionPgModel = exports.CollectionPgModel = exports.BasePgModel = exports.AsyncOperationPgModel = exports.QuerySearchClient = exports.getGranulesByApiPropertiesQuery = exports.upsertGranuleWithExecutionJoinRecord = exports.getUniqueGranuleByGranuleId = void 0;
 const path = __importStar(require("path"));
 var knex_1 = require("knex");
 Object.defineProperty(exports, "Knex", { enumerable: true, get: function () { return knex_1.Knex; } });
@@ -37,6 +37,8 @@ Object.defineProperty(exports, "fakePdrRecordFactory", { enumerable: true, get:
 Object.defineProperty(exports, "fakeProviderRecordFactory", { enumerable: true, get: function () { return test_utils_1.fakeProviderRecordFactory; } });
 Object.defineProperty(exports, "fakeRuleRecordFactory", { enumerable: true, get: function () { return test_utils_1.fakeRuleRecordFactory; } });
 Object.defineProperty(exports, "generateLocalTestDb", { enumerable: true, get: function () { return test_utils_1.generateLocalTestDb; } });
+var errors_1 = require("./lib/errors");
+Object.defineProperty(exports, "isCollisionError", { enumerable: true, get: function () { return errors_1.isCollisionError; } });
 var connection_1 = require("./connection");
 Object.defineProperty(exports, "getKnexClient", { enumerable: true, get: function () { return connection_1.getKnexClient; } });
 var config_1 = require("./config");
@@ -52,50 +54,65 @@ Object.defineProperty(exports, "validateProviderHost", { enumerable: true, get:
 Object.defineProperty(exports, "nullifyUndefinedProviderValues", { enumerable: true, get: function () { return provider_1.nullifyUndefinedProviderValues; } });
 var async_operations_1 = require("./translate/async_operations");
 Object.defineProperty(exports, "translateApiAsyncOperationToPostgresAsyncOperation", { enumerable: true, get: function () { return async_operations_1.translateApiAsyncOperationToPostgresAsyncOperation; } });
+Object.defineProperty(exports, "translatePostgresAsyncOperationToApiAsyncOperation", { enumerable: true, get: function () { return async_operations_1.translatePostgresAsyncOperationToApiAsyncOperation; } });
 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; } });
+Object.defineProperty(exports, "translatePostgresCollectionToApiCollection", { enumerable: true, get: function () { return collections_1.translatePostgresCollectionToApiCollection; } });
 var providers_1 = require("./translate/providers");
 Object.defineProperty(exports, "translateApiProviderToPostgresProvider", { enumerable: true, get: function () { return providers_1.translateApiProviderToPostgresProvider; } });
+Object.defineProperty(exports, "translatePostgresProviderToApiProvider", { enumerable: true, get: function () { return providers_1.translatePostgresProviderToApiProvider; } });
 var rules_1 = require("./translate/rules");
 Object.defineProperty(exports, "translateApiRuleToPostgresRule", { enumerable: true, get: function () { return rules_1.translateApiRuleToPostgresRule; } });
+Object.defineProperty(exports, "translatePostgresRuleToApiRule", { enumerable: true, get: function () { return rules_1.translatePostgresRuleToApiRule; } });
 var executions_1 = require("./translate/executions");
 Object.defineProperty(exports, "translateApiExecutionToPostgresExecution", { enumerable: true, get: function () { return executions_1.translateApiExecutionToPostgresExecution; } });
 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; } });
+Object.defineProperty(exports, "translatePostgresGranuleResultToApiGranule", { enumerable: true, get: function () { return granules_1.translatePostgresGranuleResultToApiGranule; } });
+var pdr_1 = require("./translate/pdr");
+Object.defineProperty(exports, "translateApiPdrToPostgresPdr", { enumerable: true, get: function () { return pdr_1.translateApiPdrToPostgresPdr; } });
+Object.defineProperty(exports, "translatePostgresPdrToApiPdr", { enumerable: true, get: function () { return pdr_1.translatePostgresPdrToApiPdr; } });
+var collection_1 = require("./lib/collection");
+Object.defineProperty(exports, "getCollectionsByGranuleIds", { enumerable: true, get: function () { return collection_1.getCollectionsByGranuleIds; } });
 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; } });
+Object.defineProperty(exports, "getExecutionInfoByGranuleCumulusId", { enumerable: true, get: function () { return execution_1.getExecutionInfoByGranuleCumulusId; } });
+var file_2 = require("./lib/file");
+Object.defineProperty(exports, "getFilesAndGranuleInfoQuery", { enumerable: true, get: function () { return file_2.getFilesAndGranuleInfoQuery; } });
 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; } });
+Object.defineProperty(exports, "getGranuleCollectionId", { enumerable: true, get: function () { return granule_1.getGranuleCollectionId; } });
+Object.defineProperty(exports, "getUniqueGranuleByGranuleId", { enumerable: true, get: function () { return granule_1.getUniqueGranuleByGranuleId; } });
 Object.defineProperty(exports, "upsertGranuleWithExecutionJoinRecord", { enumerable: true, get: function () { return granule_1.upsertGranuleWithExecutionJoinRecord; } });
+Object.defineProperty(exports, "getGranulesByApiPropertiesQuery", { enumerable: true, get: function () { return granule_1.getGranulesByApiPropertiesQuery; } });
+var QuerySearchClient_1 = require("./lib/QuerySearchClient");
+Object.defineProperty(exports, "QuerySearchClient", { enumerable: true, get: function () { return QuerySearchClient_1.QuerySearchClient; } });
 var async_operation_1 = require("./models/async_operation");
 Object.defineProperty(exports, "AsyncOperationPgModel", { enumerable: true, get: function () { return async_operation_1.AsyncOperationPgModel; } });
 var base_1 = require("./models/base");
 Object.defineProperty(exports, "BasePgModel", { enumerable: true, get: function () { return base_1.BasePgModel; } });
-var collection_1 = require("./models/collection");
-Object.defineProperty(exports, "CollectionPgModel", { enumerable: true, get: function () { return collection_1.CollectionPgModel; } });
+var collection_2 = require("./models/collection");
+Object.defineProperty(exports, "CollectionPgModel", { enumerable: true, get: function () { return collection_2.CollectionPgModel; } });
 var execution_2 = require("./models/execution");
 Object.defineProperty(exports, "ExecutionPgModel", { enumerable: true, get: function () { return execution_2.ExecutionPgModel; } });
-var file_2 = require("./models/file");
-Object.defineProperty(exports, "FilePgModel", { enumerable: true, get: function () { return file_2.FilePgModel; } });
+var file_3 = require("./models/file");
+Object.defineProperty(exports, "FilePgModel", { enumerable: true, get: function () { return file_3.FilePgModel; } });
 var granule_2 = require("./models/granule");
 Object.defineProperty(exports, "GranulePgModel", { enumerable: true, get: function () { return granule_2.GranulePgModel; } });
 var granules_executions_1 = require("./models/granules-executions");
 Object.defineProperty(exports, "GranulesExecutionsPgModel", { enumerable: true, get: function () { return granules_executions_1.GranulesExecutionsPgModel; } });
-var pdr_1 = require("./models/pdr");
-Object.defineProperty(exports, "PdrPgModel", { enumerable: true, get: function () { return pdr_1.PdrPgModel; } });
+var pdr_2 = require("./models/pdr");
+Object.defineProperty(exports, "PdrPgModel", { enumerable: true, get: function () { return pdr_2.PdrPgModel; } });
 var provider_2 = require("./models/provider");
 Object.defineProperty(exports, "ProviderPgModel", { enumerable: true, get: function () { return provider_2.ProviderPgModel; } });
 var rule_1 = require("./models/rule");

package/dist/lib/QuerySearchClient.d.ts

@@ -0,0 +1,36 @@
+import { Knex } from 'knex';
+import { BaseRecord } from '../types/base';
+/**
+ * Class to handle fetching results for an arbitrary PostgreSQL query and
+ * paging through them.
+ */
+declare class QuerySearchClient<RecordType extends BaseRecord> {
+    readonly query: Knex.QueryBuilder;
+    readonly limit: number;
+    offset: number;
+    records: RecordType[];
+    constructor(query: Knex.QueryBuilder, limit: number);
+    /**
+     * Query the PostgreSQL database for the given offset/limit to get a set of results.
+     *
+     * @returns {Promise<RecordType[]>} - set of records from PostgreSQL table
+     * @throws
+     */
+    private fetchRecords;
+    /**
+     * View the next item in the results
+     *
+     * This does not remove the object from the queue.
+     *
+     * @returns {Promise<RecordType>} - record from PostgreSQL table
+     */
+    peek(): Promise<RecordType>;
+    /**
+     * Remove and return the next item in the results
+     *
+     * @returns {Promise<RecordType>} - record from PostgreSQL table
+     */
+    shift(): Promise<RecordType | undefined>;
+}
+export { QuerySearchClient };
+//# sourceMappingURL=QuerySearchClient.d.ts.map

package/dist/lib/QuerySearchClient.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QuerySearchClient = void 0;
+/**
+ * Class to handle fetching results for an arbitrary PostgreSQL query and
+ * paging through them.
+ */
+class QuerySearchClient {
+    constructor(query, limit) {
+        this.query = query;
+        this.limit = limit;
+        this.offset = 0;
+        this.records = [];
+    }
+    /**
+     * Query the PostgreSQL database for the given offset/limit to get a set of results.
+     *
+     * @returns {Promise<RecordType[]>} - set of records from PostgreSQL table
+     * @throws
+     */
+    async fetchRecords() {
+        this.records = await (this.query
+            .offset(this.offset)
+            .limit(this.limit));
+        this.offset += this.limit;
+    }
+    /**
+     * View the next item in the results
+     *
+     * This does not remove the object from the queue.
+     *
+     * @returns {Promise<RecordType>} - record from PostgreSQL table
+     */
+    async peek() {
+        if (this.records.length === 0)
+            await this.fetchRecords();
+        return this.records[0];
+    }
+    /**
+     * Remove and return the next item in the results
+     *
+     * @returns {Promise<RecordType>} - record from PostgreSQL table
+     */
+    async shift() {
+        if (this.records.length === 0)
+            await this.fetchRecords();
+        return this.records.shift();
+    }
+}
+exports.QuerySearchClient = QuerySearchClient;
+//# sourceMappingURL=QuerySearchClient.js.map

package/dist/lib/collection.d.ts

@@ -0,0 +1,10 @@
+import { Knex } from 'knex';
+/**
+ * Get collection results for a given set of granule IDs
+ *
+ * @param {Knex} knex - Knex databse client
+ * @param {Array<string>} granuleIds - Array of granule IDs
+ * @returns {Promise<Array<Object>>} - An array of collection results
+ */
+export declare const getCollectionsByGranuleIds: (knex: Knex, granuleIds: string[]) => Promise<any[]>;
+//# sourceMappingURL=collection.d.ts.map

package/dist/lib/collection.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCollectionsByGranuleIds = void 0;
+const tables_1 = require("../tables");
+/**
+ * Get collection results for a given set of granule IDs
+ *
+ * @param {Knex} knex - Knex databse client
+ * @param {Array<string>} granuleIds - Array of granule IDs
+ * @returns {Promise<Array<Object>>} - An array of collection results
+ */
+const getCollectionsByGranuleIds = async (knex, granuleIds) => {
+    const { collections: collectionsTable, granules: granulesTable, } = tables_1.TableNames;
+    return await knex(collectionsTable)
+        .select(`${collectionsTable}.*`)
+        .innerJoin(granulesTable, `${collectionsTable}.cumulus_id`, `${granulesTable}.collection_cumulus_id`)
+        .whereIn(`${granulesTable}.granule_id`, granuleIds)
+        .groupBy(`${collectionsTable}.cumulus_id`);
+};
+exports.getCollectionsByGranuleIds = getCollectionsByGranuleIds;
+//# sourceMappingURL=collection.js.map

package/dist/lib/errors.d.ts

@@ -0,0 +1,6 @@
+interface KnexError extends Error {
+    code: string;
+}
+export declare const isCollisionError: (error: KnexError) => boolean;
+export {};
+//# sourceMappingURL=errors.d.ts.map

package/dist/lib/errors.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCollisionError = void 0;
+// Postgres error codes:
+// https://www.postgresql.org/docs/10/errcodes-appendix.html
+const isCollisionError = (error) => error.code === '23505';
+exports.isCollisionError = isCollisionError;
+//# sourceMappingURL=errors.js.map

package/dist/lib/execution.d.ts

@@ -1,9 +1,29 @@
 import { Knex } from 'knex';
 import { ExecutionPgModel } from '../models/execution';
 import { GranulesExecutionsPgModel } from '../models/granules-executions';
+import { PostgresExecutionRecord } from '../types/execution';
 export interface ArnRecord {
     arn: string;
 }
+/**
+ * Returns execution info sorted by most recent first for an input
+ * Granule Cumulus ID.
+ *
+ * @param {Object} params
+ * @param {Knex | Knex.Transaction} params.knexOrTransaction
+ *   Knex client for reading from RDS database
+ * @param {Array<string>} params.executionColumns - Columns to return from executions table
+ * @param {number} params.granuleCumulusId - The primary ID for a Granule
+ * @param {number} [params.limit] - limit to number of executions to query
+ * @returns {Promise<Partial<PostgresExecutionRecord>[]>}
+ *   Array of arn objects with the most recent first.
+ */
+export declare const getExecutionInfoByGranuleCumulusId: ({ knexOrTransaction, granuleCumulusId, executionColumns, limit, }: {
+    knexOrTransaction: Knex | Knex.Transaction;
+    granuleCumulusId: number;
+    executionColumns: string[];
+    limit?: number | undefined;
+}) => Promise<Partial<PostgresExecutionRecord>[]>;
 /**
  * Returns a list of executionArns sorted by most recent first, for an input
  * Granule Cumulus ID.
@@ -31,6 +51,7 @@ export declare const executionArnsFromGranuleIdsAndWorkflowNames: (knex: Knex, g
  *
  * @param {string} granuleId -  granuleIds
  * @param {string} workflowName - workflow name
+ * @param {Knex} testKnex - knex for testing
  * @returns {Promise<string>} - most recent exectutionArn for input parameters.
  * @throws {RecordNotFound}
  */

package/dist/lib/execution.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getApiGranuleExecutionCumulusIdsByExecution = exports.getApiExecutionCumulusIds = exports.getWorkflowNameIntersectFromGranuleIds = exports.newestExecutionArnFromGranuleIdWorkflowName = exports.executionArnsFromGranuleIdsAndWorkflowNames = exports.getExecutionArnsByGranuleCumulusId = void 0;
+exports.getApiGranuleExecutionCumulusIdsByExecution = exports.getApiExecutionCumulusIds = exports.getWorkflowNameIntersectFromGranuleIds = exports.newestExecutionArnFromGranuleIdWorkflowName = exports.executionArnsFromGranuleIdsAndWorkflowNames = exports.getExecutionArnsByGranuleCumulusId = exports.getExecutionInfoByGranuleCumulusId = void 0;
 const errors_1 = require("@cumulus/errors");
 const execution_1 = require("../models/execution");
 const granules_executions_1 = require("../models/granules-executions");
@@ -8,6 +8,32 @@ const tables_1 = require("../tables");
 const Logger = require('@cumulus/logger');
 const { getKnexClient } = require('../connection');
 const log = new Logger({ sender: '@cumulus/db/lib/execution' });
+/**
+ * Returns execution info sorted by most recent first for an input
+ * Granule Cumulus ID.
+ *
+ * @param {Object} params
+ * @param {Knex | Knex.Transaction} params.knexOrTransaction
+ *   Knex client for reading from RDS database
+ * @param {Array<string>} params.executionColumns - Columns to return from executions table
+ * @param {number} params.granuleCumulusId - The primary ID for a Granule
+ * @param {number} [params.limit] - limit to number of executions to query
+ * @returns {Promise<Partial<PostgresExecutionRecord>[]>}
+ *   Array of arn objects with the most recent first.
+ */
+const getExecutionInfoByGranuleCumulusId = async ({ knexOrTransaction, granuleCumulusId, executionColumns = ['arn'], limit, }) => {
+    const knexQuery = knexOrTransaction(tables_1.TableNames.executions)
+        .column(executionColumns.map((column) => `${tables_1.TableNames.executions}.${column}`))
+        .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.getExecutionInfoByGranuleCumulusId = getExecutionInfoByGranuleCumulusId;
 /**
  * Returns a list of executionArns sorted by most recent first, for an input
  * Granule Cumulus ID.
@@ -55,6 +81,7 @@ exports.executionArnsFromGranuleIdsAndWorkflowNames = executionArnsFromGranuleId
  *
  * @param {string} granuleId -  granuleIds
  * @param {string} workflowName - workflow name
+ * @param {Knex} testKnex - knex for testing
  * @returns {Promise<string>} - most recent exectutionArn for input parameters.
  * @throws {RecordNotFound}
  */

package/dist/lib/file.d.ts

@@ -0,0 +1,33 @@
+import { Knex } from 'knex';
+import { PostgresFileRecord } from '../types/file';
+import { PostgresGranuleRecord } from '../types/granule';
+/**
+ * Helper to build a query that returns records from the files table with data
+ * joined in from the granules table optionally filtered by collectionIds,
+ * granulesIds and providers.
+ *
+ * @param {Object} params
+ * @param {Knex} params.knex - Knex client object
+ * @param {Partial<PostgresFileRecord>} params.searchParams
+ *   Query search parameters for files table
+ * @param {Array<string>} params.sortColumns
+ *   Columns to sort results by
+ * @param {Array<string>} [params.granuleColumns]
+ *   Columns to return from granules table
+ * @param {number} [params.limit] - Limit on number of results to return. Optional.
+ * @param {Array<string>} [params.collectionIds] - Array of collectionIds to include.
+ * @param {Array<string>} [params.granuleIds] - Array of granuleIds to include.
+ * @param {Array<string>} [params.providers] - Array of providers to include.
+ * @returns {Promise<Object>} - A Knex query builder object
+ */
+export declare const getFilesAndGranuleInfoQuery: ({ knex, searchParams, sortColumns, granuleColumns, limit, collectionIds, granuleIds, providers, }: {
+    knex: Knex;
+    searchParams: Partial<PostgresFileRecord>;
+    sortColumns: (keyof PostgresFileRecord)[];
+    granuleColumns?: (keyof PostgresGranuleRecord)[] | undefined;
+    limit?: number | undefined;
+    collectionIds?: string[] | undefined;
+    granuleIds?: string[] | undefined;
+    providers?: string[] | undefined;
+}) => Knex.QueryBuilder;
+//# sourceMappingURL=file.d.ts.map

package/dist/lib/file.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFilesAndGranuleInfoQuery = void 0;
+const Collections_1 = require("@cumulus/message/Collections");
+const tables_1 = require("../tables");
+/**
+ * Helper to build a query that returns records from the files table with data
+ * joined in from the granules table optionally filtered by collectionIds,
+ * granulesIds and providers.
+ *
+ * @param {Object} params
+ * @param {Knex} params.knex - Knex client object
+ * @param {Partial<PostgresFileRecord>} params.searchParams
+ *   Query search parameters for files table
+ * @param {Array<string>} params.sortColumns
+ *   Columns to sort results by
+ * @param {Array<string>} [params.granuleColumns]
+ *   Columns to return from granules table
+ * @param {number} [params.limit] - Limit on number of results to return. Optional.
+ * @param {Array<string>} [params.collectionIds] - Array of collectionIds to include.
+ * @param {Array<string>} [params.granuleIds] - Array of granuleIds to include.
+ * @param {Array<string>} [params.providers] - Array of providers to include.
+ * @returns {Promise<Object>} - A Knex query builder object
+ */
+const getFilesAndGranuleInfoQuery = ({ knex, searchParams, sortColumns, granuleColumns = [], limit, collectionIds = [], granuleIds = [], providers = [], }) => {
+    const { collections: collectionsTable, files: filesTable, granules: granulesTable, providers: providersTable, } = tables_1.TableNames;
+    const query = knex(filesTable)
+        .select(`${filesTable}.*`)
+        .modify((queryBuilder) => {
+        if (granuleColumns.length > 0) {
+            queryBuilder.select(granuleColumns.map((column) => `${granulesTable}.${column}`));
+            queryBuilder.innerJoin(granulesTable, `${filesTable}.granule_cumulus_id`, `${granulesTable}.cumulus_id`);
+        }
+    })
+        .where(searchParams)
+        .orderBy(sortColumns);
+    if (limit) {
+        query.limit(limit);
+    }
+    if (collectionIds.length > 0) {
+        query.innerJoin(collectionsTable, `${granulesTable}.collection_cumulus_id`, `${collectionsTable}.cumulus_id`);
+        const nameVersionPairs = collectionIds.map(Collections_1.deconstructCollectionId);
+        const firstPair = nameVersionPairs.pop();
+        query.andWhere(function () {
+            const innerQuery = this;
+            innerQuery.where(firstPair);
+            nameVersionPairs.forEach((pair) => innerQuery.orWhere(pair));
+        });
+    }
+    if (granuleIds.length > 0) {
+        query.whereIn('granule_id', granuleIds);
+    }
+    if (providers.length > 0) {
+        query
+            .innerJoin(providersTable, `${granulesTable}.provider_cumulus_id`, `${providersTable}.cumulus_id`)
+            .whereIn(`${providersTable}.name`, providers);
+    }
+    return query;
+};
+exports.getFilesAndGranuleInfoQuery = getFilesAndGranuleInfoQuery;
+//# sourceMappingURL=file.js.map

package/dist/lib/granule.d.ts

@@ -1,8 +1,10 @@
 import { Knex } from 'knex';
-import { PostgresGranule } from '../types/granule';
 import { CollectionPgModel } from '../models/collection';
 import { GranulePgModel } from '../models/granule';
 import { GranulesExecutionsPgModel } from '../models/granules-executions';
+import { PostgresGranule, PostgresGranuleRecord } from '../types/granule';
+import { UpdatedAtRange } from '../types/record';
+export declare const getGranuleCollectionId: (knexOrTransaction: Knex | Knex.Transaction, granule: PostgresGranule) => Promise<string>;
 /**
  * Upsert a granule and a record in the granules/executions join table.
  *
@@ -12,9 +14,9 @@ import { GranulesExecutionsPgModel } from '../models/granules-executions';
  * @param {Object} [granulePgModel] - Granule PG model class instance
  * @param {Object} [granulesExecutionsPgModel]
  *   Granules/executions PG model class instance
- * @returns {Promise<number[]>}
+ * @returns {Promise<PostgresGranuleRecord[]>}
  */
-export declare const upsertGranuleWithExecutionJoinRecord: (knexTransaction: Knex.Transaction, granule: PostgresGranule, executionCumulusId?: number | undefined, granulePgModel?: GranulePgModel, granulesExecutionsPgModel?: GranulesExecutionsPgModel) => Promise<number[]>;
+export declare const upsertGranuleWithExecutionJoinRecord: (knexTransaction: Knex.Transaction, granule: PostgresGranule, executionCumulusId?: number | undefined, granulePgModel?: GranulePgModel, granulesExecutionsPgModel?: GranulesExecutionsPgModel) => Promise<PostgresGranuleRecord[]>;
 /**
  * Get cumulus IDs for list of granules
  *
@@ -29,6 +31,16 @@ export declare const getApiGranuleCumulusIds: (knexOrTransaction: Knex | Knex.Tr
     collectionId: string;
     granuleId: string;
 }>, collectionPgModel?: CollectionPgModel, granulePgModel?: GranulePgModel) => Promise<number[]>;
+/**
+ * Get one Granule for a granule_id. If more than one or none are found, throw an error
+ *
+ * @param {Knex | Knex.Transaction} knexOrTransaction -
+ *  DB client or transaction
+ * @param {string} granuleId - a Granule ID
+ * @param {GranulePgModel} granulePgModel - Granule PG model class instance
+ * @returns {Promise<PostgresGranuleRecord>}
+ */
+export declare const getUniqueGranuleByGranuleId: (knexOrTransaction: Knex | Knex.Transaction, granuleId: string, granulePgModel?: GranulePgModel) => Promise<PostgresGranuleRecord>;
 /**
  * Get cumulus IDs for all executions associated to a set of granules
  *
@@ -45,4 +57,24 @@ export declare const getApiGranuleExecutionCumulusIds: (knexOrTransaction: Knex
     collectionId: string;
     granuleId: string;
 }>, collectionPgModel?: CollectionPgModel, granulePgModel?: GranulePgModel, granulesExecutionsPgModel?: GranulesExecutionsPgModel) => Promise<Array<number>>;
+/**
+ * Helper to build a query to search granules by various API granule record properties.
+ *
+ * @param {Knex} knex - DB client
+ * @param {Object} searchParams
+ * @param {string | Array<string>} [searchParams.collectionIds] - Collection ID
+ * @param {string | Array<string>} [searchParams.granuleIds] - array of granule IDs
+ * @param {string} [searchParams.providerName] - Provider name
+ * @param {UpdatedAtRange} [searchParams.updatedAtRange] - Date range for updated_at column
+ * @param {string} [searchParams.status] - Granule status to search by
+ * @param {string | Array<string>} [sortByFields] - Field(s) to sort by
+ * @returns {Knex.QueryBuilder}
+ */
+export declare const getGranulesByApiPropertiesQuery: (knex: Knex, { collectionIds, granuleIds, providerNames, updatedAtRange, status, }: {
+    collectionIds?: string | string[] | undefined;
+    granuleIds?: string | string[] | undefined;
+    providerNames?: string[] | undefined;
+    updatedAtRange?: UpdatedAtRange | undefined;
+    status?: string | undefined;
+}, sortByFields?: string | string[] | undefined) => Knex.QueryBuilder;
 //# sourceMappingURL=granule.d.ts.map