From 49e88962b2606b732787320aa25bda57ce6a6ddd Mon Sep 17 00:00:00 2001 From: Matheus Teixeira Date: Wed, 6 Nov 2019 02:46:20 -0300 Subject: [PATCH] master: add connection options to driver docs --- docs/src/components/Editor.tsx | 3 +-- docs/src/components/RenderConnectionOptions.tsx | 8 ++++++++ docs/src/components/RenderSettings/index.tsx | 10 ++++++++++ docs/src/pages/driver/aws-redshift.mdx | 4 ++++ docs/src/pages/driver/cql.mdx | 4 ++++ docs/src/pages/driver/db2.mdx | 4 ++++ docs/src/pages/driver/mssql.mdx | 6 +++++- docs/src/pages/driver/mysql.mdx | 3 +++ docs/src/pages/driver/oracledb.mdx | 6 +++++- docs/src/pages/driver/postgresql.mdx | 4 ++++ docs/src/pages/driver/saphana.mdx | 6 +++++- docs/src/pages/driver/sqlite.mdx | 4 ++++ packages/extension/package.json | 2 +- 13 files changed, 58 insertions(+), 6 deletions(-) create mode 100644 docs/src/components/RenderConnectionOptions.tsx diff --git a/docs/src/components/Editor.tsx b/docs/src/components/Editor.tsx index ea93b51d5..d0a43abc7 100644 --- a/docs/src/components/Editor.tsx +++ b/docs/src/components/Editor.tsx @@ -4,7 +4,7 @@ import styled from 'styled-components'; const OriginalEditor = components.editor; -const CodeTitleHeader = styled.div` +const CodeTitleHeader: any = styled.div` background: ${(props: any) => props.theme.docz.colors.grayBg}; margin-top: 30px; margin-bottom: -31px; @@ -40,7 +40,6 @@ const CodeTitle = (props: any) => ( ); const Editor = (props: any) => { - console.log(props.children.props) if (props.children && props.children.props.title) { return ( diff --git a/docs/src/components/RenderConnectionOptions.tsx b/docs/src/components/RenderConnectionOptions.tsx new file mode 100644 index 000000000..2fefb2680 --- /dev/null +++ b/docs/src/components/RenderConnectionOptions.tsx @@ -0,0 +1,8 @@ +import React from 'react' +import RenderSettings from './RenderSettings' + +const RenderConnectionOptions = ({ exclude = [], include = [] }) => ( + +) + +export default RenderConnectionOptions; \ No newline at end of file diff --git a/docs/src/components/RenderSettings/index.tsx b/docs/src/components/RenderSettings/index.tsx index 3862c1eb4..3f273ad54 100644 --- a/docs/src/components/RenderSettings/index.tsx +++ b/docs/src/components/RenderSettings/index.tsx @@ -49,6 +49,8 @@ interface Props { path?: string; disableSearch?: boolean; title?: string; + exclude?: string[]; + include?: string[]; } class RenderSettings extends React.Component { @@ -90,6 +92,14 @@ class RenderSettings extends React.Component { render() { const search = this.state.search.toLowerCase(); let propsList = this.state.jsonProps; + const exclude = this.props.exclude || []; + const include = this.props.include || []; + + if (exclude.length > 0) + propsList = propsList.filter(prop => !exclude.includes(prop.name)); + if (include.length > 0) + propsList = propsList.filter(prop => include.includes(prop.name)); + if (search.trim()) { propsList = propsList.filter(prop => prop.name.toLowerCase().includes(search)); } diff --git a/docs/src/pages/driver/aws-redshift.mdx b/docs/src/pages/driver/aws-redshift.mdx index 5627e7bfa..019b86918 100644 --- a/docs/src/pages/driver/aws-redshift.mdx +++ b/docs/src/pages/driver/aws-redshift.mdx @@ -10,6 +10,8 @@ name: AWS Redshift ## 1. Connections +import RenderConnectionOptions from '../../components/RenderConnectionOptions.tsx' + Connection example: ```json { @@ -66,3 +68,5 @@ Using connectionURI for previous example: "connectionTimeout": 15, } ``` + + \ No newline at end of file diff --git a/docs/src/pages/driver/cql.mdx b/docs/src/pages/driver/cql.mdx index 6373c1454..af1025443 100644 --- a/docs/src/pages/driver/cql.mdx +++ b/docs/src/pages/driver/cql.mdx @@ -4,6 +4,8 @@ menu: Drivers route: /driver/cassandra --- +import RenderConnectionOptions from '../../components/RenderConnectionOptions.tsx' + # Cassandra Start Guide ## 1. Connections @@ -45,3 +47,5 @@ Cassandra driver specific options can be passed using `cqlOptions` settings. ``` You can use any options defined in https://docs.datastax.com/en/developer/nodejs-driver/4.1/api/type.ClientOptions/ in `cqlOptions`. + + \ No newline at end of file diff --git a/docs/src/pages/driver/db2.mdx b/docs/src/pages/driver/db2.mdx index b15eca67d..cf8f7f79b 100644 --- a/docs/src/pages/driver/db2.mdx +++ b/docs/src/pages/driver/db2.mdx @@ -4,6 +4,8 @@ menu: Drivers route: /driver/db2 --- +import RenderConnectionOptions from '../../components/RenderConnectionOptions.tsx' + # DB2 Start Guide ## 1. Prerequisites @@ -57,3 +59,5 @@ Connection example: "database": "MyDB" } ``` + + \ No newline at end of file diff --git a/docs/src/pages/driver/mssql.mdx b/docs/src/pages/driver/mssql.mdx index 28b7915f4..1a99ad8b7 100644 --- a/docs/src/pages/driver/mssql.mdx +++ b/docs/src/pages/driver/mssql.mdx @@ -3,6 +3,7 @@ name: MSSQL, SQL Server, Azure menu: Drivers route: /driver/mssql --- +import RenderConnectionOptions from '../../components/RenderConnectionOptions.tsx' # Microsoft SQL Server/Azure Start Guide @@ -53,4 +54,7 @@ You can use any setting defined in https://www.npmjs.com/package/mssql#configura ### v0.19.x -* Remove deprecated (v0.17.6) `sqltools.connections[].dialectOptions` in favor of `sqltools.connections[].mssqlOptions`. \ No newline at end of file +* Remove deprecated (v0.17.6) `sqltools.connections[].dialectOptions` in favor of `sqltools.connections[].mssqlOptions`. + + + \ No newline at end of file diff --git a/docs/src/pages/driver/mysql.mdx b/docs/src/pages/driver/mysql.mdx index eb7aa630a..a1dac3f00 100644 --- a/docs/src/pages/driver/mysql.mdx +++ b/docs/src/pages/driver/mysql.mdx @@ -3,6 +3,7 @@ name: MySQL menu: Drivers route: /driver/mysql --- +import RenderConnectionOptions from '../../components/RenderConnectionOptions.tsx' # MySQL Start Guide @@ -102,3 +103,5 @@ Example configuration: ] } ``` + + \ No newline at end of file diff --git a/docs/src/pages/driver/oracledb.mdx b/docs/src/pages/driver/oracledb.mdx index d1cf6b489..c69c486b4 100644 --- a/docs/src/pages/driver/oracledb.mdx +++ b/docs/src/pages/driver/oracledb.mdx @@ -4,6 +4,8 @@ menu: Drivers route: /driver/oracle --- +import RenderConnectionOptions from '../../components/RenderConnectionOptions.tsx' + # Oracle Start Guide ## 1. Prerequisites @@ -116,4 +118,6 @@ If you want to use 32bits drivers or set a different ORACLE_HOME to be used with } ``` -For more information, please, read [#281](https://github.com/mtxr/vscode-sqltools/issues/281) \ No newline at end of file +For more information, please, read [#281](https://github.com/mtxr/vscode-sqltools/issues/281) + + \ No newline at end of file diff --git a/docs/src/pages/driver/postgresql.mdx b/docs/src/pages/driver/postgresql.mdx index d22b40957..a597929be 100644 --- a/docs/src/pages/driver/postgresql.mdx +++ b/docs/src/pages/driver/postgresql.mdx @@ -4,6 +4,8 @@ menu: Drivers route: /driver/postgresql --- +import RenderConnectionOptions from '../../components/RenderConnectionOptions.tsx' + # PostgreSQL Start Guide ## 1. Connections @@ -85,3 +87,5 @@ Using connectionURI for previous example: "connectionTimeout": 15, } ``` + + \ No newline at end of file diff --git a/docs/src/pages/driver/saphana.mdx b/docs/src/pages/driver/saphana.mdx index 4a1486c4a..06ce561b3 100644 --- a/docs/src/pages/driver/saphana.mdx +++ b/docs/src/pages/driver/saphana.mdx @@ -4,6 +4,8 @@ menu: Drivers route: /driver/saphana --- +import RenderConnectionOptions from '../../components/RenderConnectionOptions.tsx' + # SAP HANA Start Guide ## 1. Prerequisites @@ -52,4 +54,6 @@ ConnectionString maps from `connectString` property: "dialect": "SAPHana", "connectString": "" // Example: "connectString": "HOST=myServer;PORT=30015;UID=MyUser;PWD=MyPassword" } -``` \ No newline at end of file +``` + + \ No newline at end of file diff --git a/docs/src/pages/driver/sqlite.mdx b/docs/src/pages/driver/sqlite.mdx index df38b994f..1c55b9311 100644 --- a/docs/src/pages/driver/sqlite.mdx +++ b/docs/src/pages/driver/sqlite.mdx @@ -4,6 +4,8 @@ menu: Drivers route: /driver/sqlite --- +import RenderConnectionOptions from '../../components/RenderConnectionOptions.tsx' + # SQLite Start Guide ## 1. Prerequisites @@ -36,3 +38,5 @@ SQLite's connections handle files so you can use the example below as reference "connectionTimeout": 15 } ``` + + \ No newline at end of file diff --git a/packages/extension/package.json b/packages/extension/package.json index e2be3ecb4..e018656f1 100644 --- a/packages/extension/package.json +++ b/packages/extension/package.json @@ -573,7 +573,7 @@ } } }, - "pqOptions": { + "pgOptions": { "type": [ "object", "null"