Interface DataSource

数据源的抽象接口

options 配置项
createEntityService 创建 entityService
getAnnotation 获取 annotation

interface DataSource {
    agent: Agent;
    options: DataSourceOptions;
    clearCache(): Promise<void>;
    createEntity(name, columns, data?): Observable<string>;
    createEntityService<T>(entity): EntityService<T>;
    discoverDBCatalogs(): Observable<DBCatalog[]>;
    discoverDBTables(): Observable<DBTable[]>;
    discoverMDCubes(refresh?): Observable<MDCube[]>;
    discoverMDMembers(entity, dimension): Observable<IDimensionMember[]>;
    dropEntity(name): Promise<void>;
    getCatalogs(): Observable<Catalog[]>;
    getEntitySets(refresh?): Observable<EntitySet[]>;
    getEntityType(entity): Observable<Error | EntityType>;
    getIndicator(id, entity?): Indicator;
    getMembers(entity, dimension): Observable<IDimensionMember[]>;
    onDestroy(): void;
    query(options): Observable<any>;
    selectEntitySet(entity): Observable<Error | EntitySet>;
    selectEntitySets(refresh?): Observable<EntitySet[]>;
    selectEntityType(entity): Observable<Error | EntityType>;
    selectIndicators(entity): Observable<Indicator[]>;
    selectMembers(entity, dimension): Observable<IDimensionMember[]>;
    selectSchema(): Observable<Schema>;
    setEntityType(entityType): void;
    setSchema(schema): void;
    updateCube(cube): void;
}

Implemented by

AbstractDataSource

Properties

agent

agent: Agent

options

options: DataSourceOptions

Methods

clearCache

clearCache(): Promise<void>
清除浏览器端缓存

Returns Promise<void>
- Defined in packages/core/src/lib/data-source.ts:235

createEntity

createEntity(name, columns, data?): Observable<string>
Create DB Table
Parameters
- name: string
- columns: any
- Optional data: any
Returns Observable<string>
- Defined in packages/core/src/lib/data-source.ts:216

createEntityService

createEntityService<T>(entity): EntityService<T>
根据指定的 entitySet 名称创建相应的 entityService
Type Parameters
- T
Parameters
- entity: string
Returns EntityService<T>
- Defined in packages/core/src/lib/data-source.ts:152

discoverDBCatalogs

discoverDBCatalogs(): Observable<DBCatalog[]>
Discover catalogs or schemas from DataSource's Database

Returns Observable<DBCatalog[]>
- Defined in packages/core/src/lib/data-source.ts:104

discoverDBTables

discoverDBTables(): Observable<DBTable[]>
Discover tables from DataSource's Database

Returns Observable<DBTable[]>
- Defined in packages/core/src/lib/data-source.ts:108

discoverMDCubes

discoverMDCubes(refresh?): Observable<MDCube[]>
Discover cubes from api or schema defination of DataSource
Parameters
- Optional refresh: boolean
Returns Observable<MDCube[]>
- Defined in packages/core/src/lib/data-source.ts:113

discoverMDMembers

discoverMDMembers(entity, dimension): Observable<IDimensionMember[]>
Discover members of dimension
Parameters
- entity: string
- dimension: Dimension
Returns Observable<IDimensionMember[]>
- Defined in packages/core/src/lib/data-source.ts:121

dropEntity

dropEntity(name): Promise<void>
Drop DB Table
Parameters
- name: string
Returns Promise<void>
- Defined in packages/core/src/lib/data-source.ts:223

getCatalogs

getCatalogs(): Observable<Catalog[]>
Returns Observable<Catalog[]>
Deprecated
use discoverDBCatalogs

获取数据源的数据服务目录, 数据服务目录用于区分不同的数据实体类别, 如 ODataService 的 Catalog, XMLA 的 CATALOG_NAME 等
- Defined in packages/core/src/lib/data-source.ts:99

getEntitySets

getEntitySets(refresh?): Observable<EntitySet[]>
Parameters
- Optional refresh: boolean
  是否跳过缓存进行重新获取数据
Returns Observable<EntitySet[]>
Deprecated
use selectEntitySets 获取源实体集合
- Defined in packages/core/src/lib/data-source.ts:129

getEntityType

getEntityType(entity): Observable<Error | EntityType>
Parameters
- entity: string
Returns Observable<Error | EntityType>
Deprecated
运行时 EntityType 接口不应该直接暴露, 使用 selectEntitySet 方法

获取运行时 EntityType
- Defined in packages/core/src/lib/data-source.ts:137

getIndicator

getIndicator(id, entity?): Indicator
Get an indicator by id from entity
Parameters
- id: string
  指标 ID
- Optional entity: string
Returns Indicator
- Defined in packages/core/src/lib/data-source.ts:207

getMembers

getMembers(entity, dimension): Observable<IDimensionMember[]>
Parameters
- entity: string
  实体
- dimension: Dimension
  维度
Returns Observable<IDimensionMember[]>
Deprecated
use selectMembers 获取维度成员
- Defined in packages/core/src/lib/data-source.ts:146

onDestroy

onDestroy(): void
Completes all relevant Observable streams.

Returns void
- Defined in packages/core/src/lib/data-source.ts:238

query

query(options): Observable<any>
使用语句查询
Parameters
- options: {
  statement: string;
  }
  - statement: string
Returns Observable<any>
- Defined in packages/core/src/lib/data-source.ts:230

selectEntitySet

selectEntitySet(entity): Observable<Error | EntitySet>
订阅 Entity 的类型定义变化，合并运行时和用户增强后的
Parameters
- entity: string
Returns Observable<Error | EntitySet>
- Defined in packages/core/src/lib/data-source.ts:178

selectEntitySets

selectEntitySets(refresh?): Observable<EntitySet[]>
Parameters
- Optional refresh: boolean
Returns Observable<EntitySet[]>
- Defined in packages/core/src/lib/data-source.ts:130

selectEntityType

selectEntityType(entity): Observable<Error | EntityType>
Subscribe type defination of entity (combine runtime type and custom types)
Parameters
- entity: string
Returns Observable<Error | EntityType>
- Defined in packages/core/src/lib/data-source.ts:192

selectIndicators

selectIndicators(entity): Observable<Indicator[]>
Subscribe indicators of entity
Parameters
- entity: string
Returns Observable<Indicator[]>
- Defined in packages/core/src/lib/data-source.ts:199

selectMembers

selectMembers(entity, dimension): Observable<IDimensionMember[]>
Parameters
- entity: string
- dimension: Dimension
Returns Observable<IDimensionMember[]>
- Defined in packages/core/src/lib/data-source.ts:147

selectSchema

selectSchema(): Observable<Schema>
监听运行时 EDM Schema 配置变化

Returns Observable<Schema>
- Defined in packages/core/src/lib/data-source.ts:157

setEntityType

setEntityType(entityType): void
单独设置一个 EntityType
Parameters
- entityType: EntityType
  EntityType
Returns void
- Defined in packages/core/src/lib/data-source.ts:185

setSchema

setSchema(schema): void
设置自定义的 Schema
Parameters
- schema: Schema
  EDMSchema
Returns void
- Defined in packages/core/src/lib/data-source.ts:164

updateCube

updateCube(cube): void
更新单个 Cube 定义
Parameters
- cube: Cube
Returns void
- Defined in packages/core/src/lib/data-source.ts:171

Interface DataSource

Implemented by

Index

Properties

Methods

Properties

agent

options

Methods

clearCache

Returns Promise<void>

createEntity

Parameters

name: string

columns: any

Optional data: any

Returns Observable<string>

createEntityService

Type Parameters

T

Parameters

entity: string

Returns EntityService<T>

discoverDBCatalogs

Returns Observable<DBCatalog[]>

discoverDBTables

Returns Observable<DBTable[]>

discoverMDCubes

Parameters

Optional refresh: boolean

Returns Observable<MDCube[]>

discoverMDMembers

Parameters

entity: string

dimension: Dimension

Returns Observable<IDimensionMember[]>

dropEntity

Parameters

name: string

Returns Promise<void>

getCatalogs

Returns Observable<Catalog[]>

Deprecated

getEntitySets

Parameters

Optional refresh: boolean

Returns Observable<EntitySet[]>

Deprecated

getEntityType

Parameters

entity: string

Returns Observable<Error | EntityType>

Deprecated

getIndicator

Parameters

id: string

Optional entity: string

Returns Indicator

getMembers

Parameters

entity: string

dimension: Dimension

Returns Observable<IDimensionMember[]>

Deprecated

onDestroy

Returns void

query

Parameters

options: { statement: string; }

statement: string

Returns Observable<any>

selectEntitySet

Parameters

entity: string

Returns Observable<Error | EntitySet>

selectEntitySets

Parameters

Optional refresh: boolean

Returns Observable<EntitySet[]>

selectEntityType

`Optional` data: any

`Optional` refresh: boolean

`Optional` refresh: boolean

`Optional` entity: string

options: {
statement: string;
}

`Optional` refresh: boolean