adding description blurbs to datasources

6 years ago · e08c917080
12 changed files with 34 additions and 4 deletions
--- 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}
--- 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
  })
 </script>
@ -55,12 +55,17 @@
      </div>
      <h3 class="section-title">{datasource.name}</h3>
    </header>
-    <Spacer extraLarge />
+
+    <Body small grey lh>{integration.description}</Body>
+
+    <hr />
+
    <div class="container">
      <div class="config-header">
        <Heading small>Configuration</Heading>
        <Button secondary on:click={saveDatasource}>Save</Button>
      </div>
+
      <Body small grey>
        Connect your database to Budibase using the config below.
      </Body>
@ -73,8 +78,6 @@

      <hr />

-      <Spacer extraLarge />
-
      <div class="query-header">
        <Heading small>Queries</Heading>
        <Button secondary on:click={() => $goto('../new')}>Add Query</Button>
@ -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;
--- 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: {
--- 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,
--- 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,
--- 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: {
--- 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: {
--- 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: {
--- 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,
--- 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",
--- 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: {
--- 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: {