This page provides an overview of features that are deprecated in Cube.js. Changes in packaging, and supported (Linux) distributions are not included. To learn about end of support for Linux distributions, refer to the changelog.
As changes are made to Cube.js, there may be times when existing features need to be removed or replaced with newer features. Before an existing feature is removed it is marked as "deprecated" within the documentation and remains in Cube.js for at least one stable release unless specified explicitly otherwise. After that time it may be removed.
Users are expected to take note of the list of deprecated features each release and plan their migration away from those features, and (if applicable) towards the replacement features as soon as possible.
The table below provides an overview of the current status of deprecated features:
- Deprecated: the feature is marked "deprecated" and should no longer be used. The feature may be removed, disabled, or change behavior in a future release. The "Deprecated" column contains the release in which the feature was marked deprecated, whereas the "Remove" column contains a tentative release in which the feature is to be removed.
- Removed: the feature was removed, disabled, or hidden. Refer to the linked section for details. Some features are "soft" deprecated, which means that they remain functional for backward compatibility, and to allow users to migrate to alternatives. In such cases, a warning may be printed, and users should not rely on this feature.
| Status | Feature | Deprecated | Remove |
|---|---|---|---|
| Removed | contextToDataSourceId |
v0.25.0 | v0.25.0 |
| Deprecated | Embedding Cube.js within Express | v0.24.0 | June 2021 |
| Deprecated | CUBEJS_ENABLE_TLS |
v0.23.11 | January 2021 |
| Deprecated | hearBeatInterval |
v0.23.8 | June 2021 |
| Deprecated | Node.js 8 | v0.22.4 | v0.26.0 |
| Deprecated | Absolute import for @cubejs-backend/query-orchestrator | v0.24.2 | v0.28.0 |
| Deprecated | Absolute import for @cubejs-backend/server-core | v0.25.4 | v0.30.0 |
Removed in Release: v0.25.0
The contextToDataSourceId option in the cube.js configuration file has been
replaced by contextToOrchestratorId. Prior to
this change, multi-tenant setups were forced to share a Query Orchestrator
instance. Now orchestrator instances can be shared by Cube.js instances and
across different tenants, if need be. Single-tenant setups should consider
removing the contextToDataSourceId property completely.
Deprecated in Release: v0.24.0
Embedding Cube.js into Express applications is deprecated due to performance and reliability considerations. Read more about this change here.
Developers are encouraged to migrate to the new cube.js configuration
file and deploy Cube.js as a microservice (or multiple
microservices, if necessary).
Deprecated in Release: v0.23.11
We no longer recommend setting TLS options via Cube.js. Developers should set up TLS on a load balancer or reverse proxy instead. Read more here.
Deprecated in Release: v0.23.8
This option for @cubejs-client/ws-transport has been
replaced by heartBeatInterval.
Deprecated in Release: v0.22.4
Node.js 8 reached End of Life on December 31, 2019. This means no more updates. Please upgrade to Node.js 10 or higher.
Deprecated in Release: v0.24.2
Reason: Absolute imports highly depend on a path, and all API becomes public. Now we started to provide public API as export from the module.
Deprecated:
const BaseDriver = require('@cubejs-backend/query-orchestrator/driver/BaseDriver');You should use:
const { BaseDriver } = require('@cubejs-backend/query-orchestrator');Deprecated in Release: v0.25.4
Reason: Absolute imports highly depend on a path, and all API becomes public. Now we started to provide public API as export from the module.
Deprecated:
const CubejsServerCore = require('@cubejs-backend/server-core');You should use:
const { CubejsServerCore } = require('@cubejs-backend/server-core');