From 86026a2c123812c66f3e3673a999d428fd71270b Mon Sep 17 00:00:00 2001 From: Martin McKeaveney Date: Fri, 19 Feb 2021 15:07:43 +0000 Subject: [PATCH] adding description blurbs to datasources --- .../components/integration/QueryViewer.svelte | 2 ++ .../datasource/[selectedDatasource]/index.svelte | 16 ++++++++++++---- packages/server/src/integrations/airtable.js | 2 ++ packages/server/src/integrations/arangodb.js | 2 ++ packages/server/src/integrations/couchdb.js | 2 ++ packages/server/src/integrations/dynamodb.js | 2 ++ .../server/src/integrations/elasticsearch.js | 2 ++ .../src/integrations/microsoftSqlServer.js | 2 ++ packages/server/src/integrations/mysql.js | 2 ++ packages/server/src/integrations/postgres.js | 2 ++ packages/server/src/integrations/rest.js | 2 ++ packages/server/src/integrations/s3.js | 2 ++ 12 files changed, 34 insertions(+), 4 deletions(-) diff --git a/packages/builder/src/components/integration/QueryViewer.svelte b/packages/builder/src/components/integration/QueryViewer.svelte index ad91b6baa0..0c3e687328 100644 --- a/packages/builder/src/components/integration/QueryViewer.svelte +++ b/packages/builder/src/components/integration/QueryViewer.svelte @@ -201,9 +201,11 @@ {#if !data[0]} + Please run your query to fetch some data. + {:else} {JSON.stringify(data[0], undefined, 2)} {/if} diff --git a/packages/builder/src/pages/[application]/data/datasource/[selectedDatasource]/index.svelte b/packages/builder/src/pages/[application]/data/datasource/[selectedDatasource]/index.svelte index e97d005884..e6821e16fe 100644 --- a/packages/builder/src/pages/[application]/data/datasource/[selectedDatasource]/index.svelte +++ b/packages/builder/src/pages/[application]/data/datasource/[selectedDatasource]/index.svelte @@ -11,6 +11,7 @@ $: datasource = $backendUiStore.datasources.find( ds => ds._id === $backendUiStore.selectedDatasourceId ) + $: integration = datasource && $backendUiStore.integrations[datasource.source] async function saveDatasource() { // Create datasource @@ -38,7 +39,6 @@ ) return false } - return true }) @@ -55,12 +55,17 @@

{datasource.name}

- + + {integration.description} + +
+
Configuration
+ Connect your database to Budibase using the config below. @@ -73,8 +78,6 @@
- -
Queries @@ -97,11 +100,16 @@ h3 { margin: 0; } + section { margin: 0 auto; width: 800px; } + hr { + margin-bottom: var(--layout-m); + } + header { margin: 0 0 var(--spacing-xs) 0; display: flex; diff --git a/packages/server/src/integrations/airtable.js b/packages/server/src/integrations/airtable.js index cae394edff..004deff16e 100644 --- a/packages/server/src/integrations/airtable.js +++ b/packages/server/src/integrations/airtable.js @@ -3,6 +3,8 @@ const { FIELD_TYPES, QUERY_TYPES } = require("./Integration") const SCHEMA = { docs: "https://airtable.com/api", + description: + "Airtable is a spreadsheet-database hybrid, with the features of a database but applied to a spreadsheet.", friendlyName: "Airtable", datasource: { apiKey: { diff --git a/packages/server/src/integrations/arangodb.js b/packages/server/src/integrations/arangodb.js index e14118e848..74d5390bff 100644 --- a/packages/server/src/integrations/arangodb.js +++ b/packages/server/src/integrations/arangodb.js @@ -4,6 +4,8 @@ const { FIELD_TYPES, QUERY_TYPES } = require("./Integration") const SCHEMA = { docs: "https://github.com/arangodb/arangojs", friendlyName: "ArangoDB", + description: + "ArangoDB is a scalable open-source multi-model database natively supporting graph, document and search. All supported data models & access patterns can be combined in queries allowing for maximal flexibility. ", datasource: { url: { type: FIELD_TYPES.STRING, diff --git a/packages/server/src/integrations/couchdb.js b/packages/server/src/integrations/couchdb.js index ab3cd8d437..df58b0e487 100644 --- a/packages/server/src/integrations/couchdb.js +++ b/packages/server/src/integrations/couchdb.js @@ -4,6 +4,8 @@ const { FIELD_TYPES, QUERY_TYPES } = require("./Integration") const SCHEMA = { docs: "https://docs.couchdb.org/en/stable/", friendlyName: "CouchDB", + description: + "Apache CouchDB is an open-source document-oriented NoSQL database, implemented in Erlang.", datasource: { url: { type: FIELD_TYPES.STRING, diff --git a/packages/server/src/integrations/dynamodb.js b/packages/server/src/integrations/dynamodb.js index 36115f9166..668e11e263 100644 --- a/packages/server/src/integrations/dynamodb.js +++ b/packages/server/src/integrations/dynamodb.js @@ -3,6 +3,8 @@ const { FIELD_TYPES, QUERY_TYPES } = require("./Integration") const SCHEMA = { docs: "https://github.com/dabit3/dynamodb-documentclient-cheat-sheet", + description: + "Amazon DynamoDB is a key-value and document database that delivers single-digit millisecond performance at any scale.", friendlyName: "DynamoDB", datasource: { region: { diff --git a/packages/server/src/integrations/elasticsearch.js b/packages/server/src/integrations/elasticsearch.js index 23c4f6fe57..be1b945893 100644 --- a/packages/server/src/integrations/elasticsearch.js +++ b/packages/server/src/integrations/elasticsearch.js @@ -4,6 +4,8 @@ const { QUERY_TYPES, FIELD_TYPES } = require("./Integration") const SCHEMA = { docs: "https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html", + description: + "Elasticsearch is a search engine based on the Lucene library. It provides a distributed, multitenant-capable full-text search engine with an HTTP web interface and schema-free JSON documents.", friendlyName: "ElasticSearch", datasource: { url: { diff --git a/packages/server/src/integrations/microsoftSqlServer.js b/packages/server/src/integrations/microsoftSqlServer.js index 4f4da88cc3..eea67a7256 100644 --- a/packages/server/src/integrations/microsoftSqlServer.js +++ b/packages/server/src/integrations/microsoftSqlServer.js @@ -3,6 +3,8 @@ const { FIELD_TYPES } = require("./Integration") const SCHEMA = { docs: "https://github.com/tediousjs/node-mssql", + description: + "Microsoft SQL Server is a relational database management system developed by Microsoft. ", friendlyName: "MS SQL Server", datasource: { user: { diff --git a/packages/server/src/integrations/mysql.js b/packages/server/src/integrations/mysql.js index fe0f8e3f8b..48c0a4d704 100644 --- a/packages/server/src/integrations/mysql.js +++ b/packages/server/src/integrations/mysql.js @@ -4,6 +4,8 @@ const { FIELD_TYPES, QUERY_TYPES } = require("./Integration") const SCHEMA = { docs: "https://github.com/mysqljs/mysql", friendlyName: "MySQL", + description: + "MySQL Database Service is a fully managed database service to deploy cloud-native applications. ", datasource: { host: { type: FIELD_TYPES.STRING, diff --git a/packages/server/src/integrations/postgres.js b/packages/server/src/integrations/postgres.js index 4d13048ae6..c6a24577b3 100644 --- a/packages/server/src/integrations/postgres.js +++ b/packages/server/src/integrations/postgres.js @@ -3,6 +3,8 @@ const { Client } = require("pg") const SCHEMA = { docs: "https://node-postgres.com", friendlyName: "PostgreSQL", + description: + "PostgreSQL, also known as Postgres, is a free and open-source relational database management system emphasizing extensibility and SQL compliance.", datasource: { host: { type: "string", diff --git a/packages/server/src/integrations/rest.js b/packages/server/src/integrations/rest.js index 184b59149b..151cc22889 100644 --- a/packages/server/src/integrations/rest.js +++ b/packages/server/src/integrations/rest.js @@ -3,6 +3,8 @@ const { FIELD_TYPES, QUERY_TYPES } = require("./Integration") const SCHEMA = { docs: "https://github.com/node-fetch/node-fetch", + description: + "Representational state transfer (REST) is a de-facto standard for a software architecture for interactive applications that typically use multiple Web services. ", friendlyName: "REST API", datasource: { url: { diff --git a/packages/server/src/integrations/s3.js b/packages/server/src/integrations/s3.js index 5eb038819d..83d3508ee3 100644 --- a/packages/server/src/integrations/s3.js +++ b/packages/server/src/integrations/s3.js @@ -2,6 +2,8 @@ const AWS = require("aws-sdk") const SCHEMA = { docs: "https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html", + description: + "Amazon Simple Storage Service (Amazon S3) is an object storage service that offers industry-leading scalability, data availability, security, and performance.", friendlyName: "Amazon S3", datasource: { region: {