Interface DataAccessInterface

Interface to implements for each Data Provider/Storage. ie: file system storage, database, etc

Hierarchy

DataAccessInterface

Implemented by

Index

Methods

Methods

checkIfExist

checkIfExist(source: SourceEnum, path: string): Promise<boolean>

- Defined in data_access/dataAccess.interface.ts:41
Check if data already exist into the Data Storage

Parameters
- source: SourceEnum
  
  data source (env, rule, ...)
- path: string
  
  data path
Returns Promise<boolean>

connect

connect(): Promise<boolean>

- Defined in data_access/dataAccess.interface.ts:60
Open connection with the Data Storage

Returns Promise<boolean>

deleteData

deleteData(source: SourceEnum, path: string): Promise<any>

- Defined in data_access/dataAccess.interface.ts:35
Delete data from the Data Storage

Parameters
- source: SourceEnum
  
  data source (env, rule, ...)
- path: string
  
  data path
Returns Promise<any>

readCollection

readCollection(source: SourceEnum, path: string): Promise<any>

- Defined in data_access/dataAccess.interface.ts:48
Read all collection data from the Data Storage

Parameters
- source: SourceEnum
  
  data source (env, rules, ...)
- path: string
  
  collection path
Returns Promise<any>

readData

readData(source: SourceEnum, path: string): Promise<any>

- Defined in data_access/dataAccess.interface.ts:22
Read data from the Data Storage

Parameters
- source: SourceEnum
  
  data source (env, rule, ...)
- path: string
  
  data path
Returns Promise<any>

removeCollection

removeCollection(source: SourceEnum, path: string): Promise<boolean>

- Defined in data_access/dataAccess.interface.ts:55
Remove all collection data from the Data Storage

Parameters
- source: SourceEnum
  
  data source (env, rules, ...)
- path: string
  
  collection path
Returns Promise<boolean>

writeData

writeData(source: SourceEnum, path: string, data: any): Promise<any>

- Defined in data_access/dataAccess.interface.ts:29
Write data into the Data Storage

Parameters
- source: SourceEnum
  
  data source (env, rule, ...)
- path: string
  
  data path
- data: any
  
  data to write
Returns Promise<any>

Generated using TypeDoc