ravendb/dist/commonjs/Documents/TimeSeries/TimeSeriesOperations.d.ts

RavenDB client for Node.js

import { IDocumentStore } from "../IDocumentStore.js";
import { TimeValue } from "../../Primitives/TimeValue.js";
import { ClassConstructor } from "../../Types/index.js";
import { DocumentConventions } from "../Conventions/DocumentConventions.js";
export declare class TimeSeriesOperations {
    private readonly _store;
    private readonly _database;
    private readonly _executor;
    constructor(store: IDocumentStore);
    constructor(store: IDocumentStore, database: string);
    /**
     * Register value names of a time-series
     * @param collectionClass Collection class
     * @param timeSeriesEntryClass Time-series entry class
     */
    register<TCollection extends object, TTimeSeriesEntry extends object>(collectionClass: ClassConstructor<TCollection>, timeSeriesEntryClass: ClassConstructor<TTimeSeriesEntry>): Promise<void>;
    /**
     * Register value names of a time-series
     * @param collectionClass Collection class
     * @param timeSeriesEntryClass Time-series entry class
     * @param name Override time series entry name
     */
    register<TCollection extends object, TTimeSeriesEntry extends object>(collectionClass: ClassConstructor<TCollection>, timeSeriesEntryClass: ClassConstructor<TTimeSeriesEntry>, name: string): Promise<void>;
    /**
     * Register value name of a time-series
     * @param collectionClass Collection class
     * @param name Time series name
     * @param valueNames Values to register
     */
    register<TCollection extends object>(collectionClass: ClassConstructor<TCollection>, name: string, valueNames: string[]): Promise<void>;
    /**
     * Register value name of a time-series
     * @param collection Collection name
     * @param name Time series name
     * @param valueNames Values to register
     */
    register(collection: string, name: string, valueNames: string[]): Promise<void>;
    private _registerInternal;
    /**
     * Set rollup and retention policy
     * @param collectionClass Collection class
     * @param name Policy name
     * @param aggregation Aggregation time
     * @param retention Retention time
     */
    setPolicy<TCollection extends object>(collectionClass: ClassConstructor<TCollection>, name: string, aggregation: TimeValue, retention: TimeValue): Promise<void>;
    /**
     * Set rollup and retention policy
     * @param collection Collection name
     * @param name Policy name
     * @param aggregation Aggregation time
     * @param retention Retention time
     */
    setPolicy<TCollection extends object>(collection: string, name: string, aggregation: TimeValue, retention: TimeValue): Promise<void>;
    /**
     * Set raw retention policy
     * @param collectionClass Collection class
     * @param retention Retention time
     */
    setRawPolicy<TCollection extends object>(collectionClass: ClassConstructor<TCollection>, retention: TimeValue): Promise<void>;
    /**
     * Set raw retention policy
     * @param collection Collection name
     * @param retention Retention time
     */
    setRawPolicy(collection: string, retention: TimeValue): Promise<void>;
    /**
     * Remove policy
     * @param collection Collection name
     * @param name Policy name
     */
    removePolicy(collection: string, name: string): Promise<void>;
    /**
     * Remove policy
     * @param clazz Collection class
     * @param name Policy name
     */
    removePolicy<TCollection extends object>(clazz: ClassConstructor<TCollection>, name: string): Promise<void>;
    static getTimeSeriesName<TTimeSeriesEntry extends object>(clazz: ClassConstructor<TTimeSeriesEntry>, conventions: DocumentConventions): string;
    forDatabase(database: string): TimeSeriesOperations;
}
//# sourceMappingURL=TimeSeriesOperations.d.ts.map