@lowdefy/docs 4.0.0-alpha.7 → 4.0.0-alpha.8

package/connections/GoogleSheet.yaml

@@ -1,332 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/general.yaml.njk
-  vars:
-    pageId: GoogleSheet
-    pageTitle: Google Sheets
-    section: Connections
-    filePath: connections/GoogleSheet.yaml
-    content:
-      - id: markdown
-        type: MarkdownWithCode
-        properties:
-          content: |
-            ## Connections
-
-            Connection types:
-              - GoogleSheet
-
-            ### GoogleSheet
-
-            The `GoogleSheet` connection can be used to connect to a Google using an API key or a service account. An API key can only be used for read-only access to public sheets, so most applications should use a service account. A guide to creating a service account can be found in the [tutorial](/tutorial-requests).
-
-            This connection refers to the entire document as the `spreadsheet`, and the individual sheets in the document as `sheets`. The spreadsheet is identified by it's `spreadsheetId`, and sheets can either be identified by their `sheetId` or their `index` (position in the document starting from 0).
-
-            When a sheet is accessed in a browser the url either looks like:
-            `https://docs.google.com/spreadsheets/d/{spreadsheetId}/edit#gid={sheetId}`
-
-            The `GoogleSheet` connection works with sheets as a row based data store. Each row is a data record, and a header row needs to be present to define the column names. This header needs to be created in the Google Sheets web interface. Types can be specified for any of the columns in the sheet. If a type is not specified, the value will be read as a string. The `json` type will stringify a object as JSON before saving it, and parse it again when reading.
-
-            #### Properties
-            - `apiKey: string`: API key for your google project.
-            - `client_email: string`: The email address of your service account.
-            - `private_key: string`: The private key for your service account. Base64 encode the string if you have issues with the newline characters in the string.
-            - `sheetId: string`: The ID of the worksheet. Can be found in the URL as the "gid" parameter. One of `sheetId` or `sheetIndex` is required.
-            - `sheetIndex: number`: The position of the worksheet as they appear in the Google sheets UI. Starts from 0. One of `sheetId` or `sheetIndex` is required.
-            - `spreadsheetId: string`: __Required__ - The document ID from the URL of the spreadsheet.
-            - `columnTypes: object`: An object that defines the data types for each column. Each key should be the column name, and the value should be one of: `string`, `number`, `boolean`, `date`, or `json`.
-            - `read: boolean`: Default: `true` - Allow read operations like find on the sheet.
-            - `write: boolean`: Default: `false` - Allow write operations like update on the sheet.
-
-            #### Examples
-
-            ###### Read only access to first sheet in a public spreadsheet:
-            ```yaml
-            connections:
-              - id: public_sheet
-                type: GoogleSheet
-                properties:
-                  apiKey:
-                    _secret: GOOGLE_SHEETS_API_KEY
-                  sheetIndex: 0
-                  spreadsheetId: ubQsWYNGRUq0gFB1sAp2r9oYE19lZ8yGA1T6y0yBoLPW
-            ```
-
-            ###### Access with a service account, with defined types:
-            ```yaml
-            connections:
-              - id: my_sheet
-                type: GoogleSheet
-                properties:
-                  client_email:
-                    _secret: GOOGLE_SHEETS_CLIENT_EMAIL
-                  private_key:
-                    _base64.decode:
-                      _secret: GOOGLE_SHEETS_PRIVATE_KEY
-                  sheetId: '1199545345'
-                  spreadsheetId: ubQsWYNGRUq0gFB1sAp2r9oYE19lZ8yGA1T6y0yBoLPW
-                  columnTypes:
-                    name: string
-                    age: number
-                    birthday: date
-                    subscribed: boolean
-                    address: json
-            ```
-
-            ## Requests
-
-            Request types:
-              - GoogleSheetAppendMany
-              - GoogleSheetAppendOne
-              - GoogleSheetDeleteOne
-              - GoogleSheetGetMany
-              - GoogleSheetGetOne
-              - GoogleSheetUpdateMany
-              - GoogleSheetUpdateOne
-
-            ### GoogleSheetAppendMany
-
-            The `GoogleSheetAppendMany` request inserts an array of documents as rows in a Google Sheet.
-
-            #### Properties
-            - `rows: object[]`: __Required__ - The rows to insert into the sheet. An an array of objects where keys are the column names and values are the values to insert.
-            - `options: object`: Optional settings. Supported settings are:
-              - `raw: boolean`: Store raw values instead of converting as if typed into the sheets UI.
-
-            #### Examples
-
-            ###### Insert a list of rows.
-            ```yaml
-            requests:
-              - id: append_rows
-                type:  GoogleSheetAppendMany
-                connectionId: google_sheets
-                properties:
-                  rows:
-                    - name: D.Va
-                      role: Tank
-                    - name: Tracer
-                      role: Damage
-                    - name: Genji
-                      role: Damage
-                    - name: Reinhart
-                      role: Tank
-                    - name: Mercy
-                      role: Support
-            ```
-
-            ### GoogleSheetAppendOne
-
-            The `GoogleSheetAppendOne` request inserts a documents as a row in a Google Sheet.
-
-            #### Properties
-            - `row: object`: __Required__ - The row to insert into the sheet. An object where keys are the column names and values are the values to insert.
-            - `options: object`: Optional settings. Supported settings are:
-              - `raw: boolean`: Store raw values instead of converting as if typed into the sheets UI.
-
-            #### Examples
-
-            ###### Insert a single row:
-            ```yaml
-            requests:
-              - id: insert_dva
-                type:  GoogleSheetAppendOne
-                connectionId: google_sheets
-                properties:
-                  row:
-                    name: D.Va
-                    role: Tank
-                    real_name: Hana Song
-                    age: 19
-            ```
-
-            ### GoogleSheetDeleteOne
-
-            The `GoogleSheetDeleteOne` request deletes a row from a Google Sheet. It deletes the first row matched by the filter, written as a MongoDB query expression.
-
-            #### Properties
-            - `filter: object`: __Required__ - A MongoDB query expression to filter the data. The first row matched by the filter will be deleted.
-            - `options: object`: Optional settings. Supported settings are:
-              - `limit: number`: The maximum number of rows to fetch.
-              - `skip: number`: The number of rows to skip from the top of the sheet.
-
-            #### Examples
-
-            ###### Delete the row where name is "Hanzo".
-            ```yaml
-            requests:
-              - id: delete_hanzo
-                type:  GoogleSheetDeleteOne
-                connectionId: google_sheets
-                properties:
-                  filter:
-                    name:
-                      $eq: Hanzo
-            ```
-
-            ### GoogleSheetGetMany
-
-            The `GoogleSheetGetMany` request fetches a number of rows from the spreadsheet. The `limit` and `skip` options can be used to control which documents are read from the spreadsheet. The filter or pipeline options can then be used to filter or transform the fetched data.
-
-            #### Properties
-            - `filter: object`: A MongoDB query expression to filter the data.
-            - `pipeline: object[]`: A MongoDB aggregation pipeline to transform the data.
-            - `options: object`: Optional settings. Supported settings are:
-              - `limit: number`: The maximum number of rows to fetch.
-              - `skip: number`: The number of rows to skip from the top of the sheet.
-
-            #### Examples
-
-            ###### Get the first 10 rows.
-            ```yaml
-            requests:
-              - id: get_10_rows
-                type:  GoogleSheetGetMany
-                connectionId: google_sheets
-                properties:
-                  options:
-                    limit: 10
-            ```
-
-            ###### Pagination using limit and skip.
-            ```yaml
-            requests:
-              - id: get_10_rows
-                type:  GoogleSheetGetMany
-                connectionId: google_sheets
-                properties:
-                  options:
-                    skip:
-                      _product:
-                        - _state: page_size
-                        - _subtract:
-                            - _state: page_number
-                            - 1
-                    limit:
-                      _state: page_size
-            ```
-
-            ###### Get all records where age is greater than 25.
-            ```yaml
-            requests:
-              - id: get_10_rows
-                type:  GoogleSheetGetMany
-                connectionId: google_sheets
-                properties:
-                  filter:
-                    age:
-                      $gt: 25
-            ```
-
-            ###### Use an aggregation pipeline to aggregate data.
-            ```yaml
-            requests:
-              - id: get_10_rows
-                type:  GoogleSheetGetMany
-                connectionId: google_sheets
-                properties:
-                  pipeline:
-                    - $group:
-                        _id: $region
-                        score:
-                          $avg: $score
-                    - $project:
-                        _id: 0
-                        region: $_id
-                        score: 1
-                    - $sort:
-                        score: 1
-            ```
-
-            ### GoogleSheetGetOne
-
-            The `GoogleSheetGetOne` request fetches a single rows from the spreadsheet. The `limit` and `skip` options can be used to control which documents are read from the spreadsheet. The filter option can then be used to filter or select which row is returned.
-
-            #### Properties
-            - `filter: object`: A MongoDB query expression to filter the data.
-            - `options: object`: Optional settings. Supported settings are:
-              - `limit: number`: The maximum number of rows to fetch.
-              - `skip: number`: The number of rows to skip from the top of the sheet.
-
-            #### Examples
-
-            ###### Get row where name is "Zarya".
-            ```yaml
-            requests:
-              - id: get_10_rows
-                type:  GoogleSheetGetOne
-                connectionId: google_sheets
-                properties:
-                  filter:
-                    name:
-                      $eq: Zarya
-            ```
-
-            ### GoogleSheetUpdateMany
-
-            The `GoogleSheetUpdateMany` request updates all the rows matched by the filter.
-
-            #### Properties
-            - `filter: object`: A MongoDB query expression to filter the data. . All rows matched by the filter will be updated.
-            - `update: object`: The update to apply to the row. An object where keys are the column names and values are the updated values.
-            - `options: object`: Optional settings. Supported settings are:
-              - `limit: number`: The maximum number of rows to fetch.
-              - `raw: boolean`: Store raw values instead of converting as if typed into the sheets UI.
-              - `skip: number`: The number of rows to skip from the top of the sheet.
-
-            #### Examples
-
-            ###### Update all rows where age is less than 18.
-            ```yaml
-            requests:
-              - id: get_10_rows
-                type:  GoogleSheetUpdateMany
-                connectionId: google_sheets
-                properties:
-                  filter:
-                    age:
-                      $lt: 18
-                  update:
-                    minor: true
-            ```
-            ### GoogleSheetUpdateOne
-
-            The `GoogleSheetUpdateOne` request updates the first row matched by the filter.
-
-            #### Properties
-            - `filter: object`: A MongoDB query expression to filter the data. . The first row matched by the filter will be updated.
-            - `update: object`: The update to apply to the row. An object where keys are the column names and values are the updated values.
-            - `options: object`: Optional settings. Supported settings are:
-              - `limit: number`: The maximum number of rows to fetch.
-              - `raw: boolean`: Store raw values instead of converting as if typed into the sheets UI.
-              - `skip: number`: The number of rows to skip from the top of the sheet.
-              - `upsert: boolean`: Insert the row if no rows are matched by the filter.
-
-            #### Examples
-
-            ###### Update the row for "Doomfist"
-            ```yaml
-            requests:
-              - id: get_10_rows
-                type:  GoogleSheetUpdateOne
-                connectionId: google_sheets
-                properties:
-                  filter:
-                    name:
-                      $eq: Doomfist
-                  update:
-                    overpowered: true
-            ```

package/connections/Knex.yaml

@@ -1,181 +0,0 @@
-# Copyright 2020-2021 Lowdefy, Inc
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-
-#     http://www.apache.org/licenses/LICENSE-2.0
-
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-_ref:
-  path: templates/general.yaml.njk
-  vars:
-    pageId: Knex
-    pageTitle: Knex
-    section: Connections
-    filePath: connections/Knex.yaml
-    content:
-      - id: markdown_intro
-        type: MarkdownWithCode
-        properties:
-          content: |
-            [`Knex.js`](http://knexjs.org) is a SQL query builder that can be used to connect to [PostgreSQL](/PostgreSQL), [MS SQL Server](/MSSQL), [MySQL](/MySQL), [MariaDB](/MariaDB), [SQLite](/SQLite), [Oracle](/Oracle), and [Amazon Redshift](/AmazonRedshift) databases.
-
-            The Knex connection can be used to execute raw SQL queries using the `KnexRaw` requests, or the Knex query builder can be used with the `KnexBuilder` request.
-
-            For more details on specific databases, see the database documentation:
-      - id: amazon_redshift_link
-        type: Anchor
-        properties:
-          title: Amazon Redshift
-          icon: AiOutlinedLink
-        events:
-          onClick:
-            - id: link,
-              type: Link
-              params:
-                pageId: AmazonRedshift
-      - id: mariadb_link
-        type: Anchor
-        properties:
-          title: MariaDB
-          icon: AiOutlinedLink
-        events:
-          onClick:
-            - id: link,
-              type: Link
-              params:
-                pageId: MariaDB
-      - id: mssql_link
-        type: Anchor
-        properties:
-          title: MS SQL Server
-          icon: AiOutlinedLink
-        events:
-          onClick:
-            - id: link,
-              type: Link
-              params:
-                pageId: MSSQL
-      - id: mysql_link
-        type: Anchor
-        properties:
-          title: MySQL
-          icon: AiOutlinedLink
-        events:
-          onClick:
-            - id: link,
-              type: Link
-              params:
-                pageId: MySQL
-      - id: oracle_link
-        type: Anchor
-        properties:
-          title: Oracle Database
-          icon: AiOutlinedLink
-        events:
-          onClick:
-            - id: link,
-              type: Link
-              params:
-                pageId: OracleDB
-      - id: postgresql_link
-        type: Anchor
-        properties:
-          title: PostgreSQL
-          icon: AiOutlinedLink
-        events:
-          onClick:
-            - id: link,
-              type: Link
-              params:
-                pageId: PostgreSQL
-      - id: sqlite_link
-        type: Anchor
-        properties:
-          title: SQLite
-          icon: AiOutlinedLink
-        events:
-          onClick:
-            - id: link,
-              type: Link
-              params:
-                pageId: SQLite
-      - id: markdown_connection
-        type: MarkdownWithCode
-        properties:
-          content: |
-            ## Connections
-
-            Connection types:
-              - Knex
-
-            ### Knex
-
-            #### Properties
-            - `client: enum`: __Required__ - The database client to use. One of:
-              - `mssql`
-              - `mysql`
-              - `oracledb`
-              - `postgres`
-              - `pg` (alias of `postgres`)
-              - `postgresql` (alias of `postgres`)
-              - `redshift`
-              - `sqlite3`
-              - `sqlite` (alias of `sqlite3`)
-            - `connection: object | string`: __Required__ - Connection string or object to pass to the database client. See the specific client documentation for more details.
-            - `searchPath: string`:  Set PostgreSQL search path.
-            - `version: string`:  Set database version.
-            - `useNullAsDefault: boolean`: If true, undefined keys are replaced with NULL instead of DEFAULT.
-
-            #### Examples
-
-            ###### MySQL with connection object:
-            ```yaml
-            connections:
-              - id: mysql
-                type: Knex
-                properties:
-                  client: mysql
-                  connection:
-                    host:
-                      _secret: MYSQL_HOST
-                    user:
-                      _secret: MYSQL_USER
-                    database:
-                      _secret: MYSQL_DB
-                    password:
-                      _secret: MYSQL_PASSWORD
-            ```
-            Environment variables:
-            ```
-            LOWDEFY_SECRET_MYSQL_HOST = database.server.com
-            LOWDEFY_SECRET_MYSQL_DB = db
-            LOWDEFY_SECRET_MYSQL_USER = user
-            LOWDEFY_SECRET_MYSQL_PASSWORD = password
-            ```
-
-            ###### PostgreSQL with secret connection string:
-            ```yaml
-            connections:
-              - id: postgres
-                type: Knex
-                properties:
-                  client: postgres
-                  connection:
-                    _secret: PG_CONNECTION_STRING
-            ```
-            Environment variables:
-            ```
-            LOWDEFY_SECRET_PG_CONNECTION_STRING = postgresql://user:password@database.server.com:5432/db
-            ```
-      - id: markdown_requests
-        type: MarkdownWithCode
-        properties:
-          content:
-            _ref: connections/KnexRequests.md

package/connections/KnexRequests.md

@@ -1,121 +0,0 @@
-## Requests
-
-Request types:
-
-- KnexBuilder
-- KnexRaw
-
-### KnexBuilder
-
-#### Properties
-
-- `query: object[]`: **Required** - SQL query builder array. An array of objects, with a single key which is the name of the knex builder function. The value should be an array of arguments to pass to the builder function.
-- `tableName: string | object`: The name of the table to query from.
-
-#### Examples
-
-###### Build a query:
-
-```yaml
-id: knexBuilder
-type: KnexBuilder
-connectionId: knex
-properties:
-  query:
-    - select:
-        - '*'
-    - from:
-        - users
-    - where:
-        - name
-        - _state: name
-```
-
-###### Using `tableName`:
-
-```yaml
-id: knexBuilder
-type: KnexBuilder
-connectionId: knex
-properties:
-  tableName: users
-  query:
-    - select:
-        - '*'
-    - where:
-        - name
-        - _state: name
-```
-
-###### Aliases:
-
-```yaml
-id: knexBuilder
-type: KnexBuilder
-connectionId: knex
-properties:
-  tableName:
-    a: tableA
-    b: tableB
-  query:
-    - select:
-        - aField: 'a.field'
-        - bField: 'b.field'
-    - limit:
-        - 1
-```
-
-### KnexRaw
-
-#### Properties
-
-- `query: string`: **Required** - SQL query string.
-- `parameters: string | number | array | object`: SQL query parameters.
-
-#### Examples
-
-###### Simple raw query:
-
-```yaml
-id: knexRaw
-type: KnexRaw
-connectionId: knex
-properties:
-  query: SELECT * FROM "my_table";
-```
-
-###### Query with named parameters:
-
-```yaml
-id: knexRaw
-type: KnexRaw
-connectionId: knex
-properties:
-  query: select * from users where name = :name
-  parameters:
-    name:
-      _state: selected_name
-```
-
-###### Query with positional parameters:
-
-```yaml
-id: knexRaw
-type: KnexRaw
-connectionId: knex
-properties:
-  query: select * from users where name = ?
-  parameters:
-    - _state: selected_name
-```
-
-###### Reference a `.sql` file:
-
-```yaml
-id: knexRaw
-type: KnexRaw
-connectionId: knex
-properties:
-  query:
-    _ref: my_query.sql
-```