Skip to content

Commit a51240c

Browse files
committed
Add compatibility warning for SurrealDB v2.0
1 parent c4ebce8 commit a51240c

File tree

3 files changed

+26
-4
lines changed

3 files changed

+26
-4
lines changed

.github/workflows/e2e.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,5 +71,9 @@ jobs:
7171
retention-days: 30
7272
strategy:
7373
matrix:
74-
surreal-version: ['latest', '1.5.4']
74+
surreal-version: [
75+
# TODO: re-enable this step when the 2.0 is supported
76+
# 'latest',
77+
'1.5.4',
78+
]
7579
timeout-minutes: 60

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
The SurrealDB datasource plugin enables you to query and visualize SurrealDB data directly within Grafana, offering seamless integration and exploration of SurrealDB datasets.
44

5+
## ⚠️ SurrealDB v2.0 compatibility
6+
7+
**Important:** The Grafana SurrealDB datasource currently does not support SurrealDB v2.0. Please ensure you are using a compatible version of SurrealDB (v1.x) for full functionality. Follow the GitHub issue [here](https://github.com/grafana/surrealdb-datasource/issues/441) for updates on compatibility.
8+
59
## ⚠️ This plugin is currently experimental
610

711
This means that while we believe in its potential and are enthusiastic about its development, **we are not yet ready to make a long-term commitment to maintaining it indefinitely**. The plugin is still under active development and may contain bugs. We do not recommend using this plugin in production environments.

src/components/ConfigEditor.tsx

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import React, { ChangeEvent } from 'react';
2-
import { Alert, Divider, Field, Input, SecretInput, TextLink, VerticalGroup } from '@grafana/ui';
2+
import { Alert, Divider, Field, Input, SecretInput, Stack, TextLink, VerticalGroup } from '@grafana/ui';
33
import { DataSourceDescription, ConfigSection } from '@grafana/experimental';
44
import { DataSourcePluginOptionsEditorProps } from '@grafana/data';
55
import type { SurrealDataSourceOptions, SurrealSecureJsonData } from '../types';
@@ -87,8 +87,21 @@ export function ConfigEditor({ onOptionsChange, options }: Props) {
8787
hasRequiredFields
8888
/>
8989
<Divider />
90+
<Alert title="SurrealDB v2.0 compatibility" severity="warning">
91+
<Stack direction='column'>
92+
<div>
93+
The Grafana SurrealDB datasource currently does not support SurrealDB v2.0. Please ensure you are using a
94+
compatible version of SurrealDB (v1.x) for full functionality. Follow the GitHub issue{' '}
95+
<TextLink href="https://github.com/grafana/surrealdb-datasource/issues/441" external inline>
96+
here
97+
</TextLink>{' '}
98+
for updates on compatibility.
99+
</div>
100+
</Stack>
101+
</Alert>
102+
90103
<Alert title="This datasource is currently experimental" severity="warning">
91-
<VerticalGroup>
104+
<Stack direction='column'>
92105
<div>
93106
This means that you might encounter unexpected behavior, bugs, or limitations while using this datasource.
94107
We strongly advise exercising caution and understanding the potential risks associated with using
@@ -101,8 +114,9 @@ export function ConfigEditor({ onOptionsChange, options }: Props) {
101114
</TextLink>
102115
!
103116
</div>
104-
</VerticalGroup>
117+
</Stack>
105118
</Alert>
119+
106120
<ConfigSection title="Server">
107121
<Field
108122
required

0 commit comments

Comments
 (0)