diff --git a/docs/developers/applications/example-projects.md b/docs/developers/applications/example-projects.md deleted file mode 100644 index 3c2342a3..00000000 --- a/docs/developers/applications/example-projects.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Example Projects ---- - -# Example Projects - -**Library of example Harper applications and components:** - -- [Authorization in Harper using Okta Customer Identity Cloud](https://www.harperdb.io/post/authorization-in-harperdb-using-okta-customer-identity-cloud), by Yitaek Hwang - -- [How to Speed Up your Applications by Caching at the Edge with Harper](https://dev.to/doabledanny/how-to-speed-up-your-applications-by-caching-at-the-edge-with-harperdb-3o2l), by Danny Adams - -- [OAuth Authentication in Harper using Auth0 & Node.js](https://www.harperdb.io/post/oauth-authentication-in-harperdb-using-auth0-and-node-js), by Lucas Santos - -- [How To Create a CRUD API with Next.js & Harper Custom Functions](https://www.harperdb.io/post/create-a-crud-api-w-next-js-harperdb), by Colby Fayock - -- [Build a Dynamic REST API with Custom Functions](https://harperdb.io/blog/build-a-dynamic-rest-api-with-custom-functions/), by Terra Roush - -- [How to use Harper Custom Functions to Build your Entire Backend](https://dev.to/andrewbaisden/how-to-use-harperdb-custom-functions-to-build-your-entire-backend-a2m), by Andrew Baisden - -- [Using TensorFlowJS & Harper Custom Functions for Machine Learning](https://harperdb.io/blog/using-tensorflowjs-harperdb-for-machine-learning/), by Kevin Ashcraft - -- [Build & Deploy a Fitness App with Python & Harper](https://www.youtube.com/watch?v=KMkmA4i2FQc), by Patrick Löber - -- [Create a Discord Slash Bot using Harper Custom Functions](https://geekysrm.hashnode.dev/discord-slash-bot-with-harperdb-custom-functions), by Soumya Ranjan Mohanty - -- [How I used Harper Custom Functions to Build a Web App for my Newsletter](https://blog.hrithwik.me/how-i-used-harperdb-custom-functions-to-build-a-web-app-for-my-newsletter), by Hrithwik Bharadwaj - -- [How I used Harper Custom Functions and Recharts to create Dashboard](https://blog.greenroots.info/how-to-create-dashboard-with-harperdb-custom-functions-and-recharts), by Tapas Adhikary - -- [How To Use Harper Custom Functions With Your React App](https://dev.to/tyaga001/how-to-use-harperdb-custom-functions-with-your-react-app-2c43), by Ankur Tyagi - -- [Build a Web App Using Harper’s Custom Functions](https://www.youtube.com/watch?v=rz6prItVJZU), livestream by Jaxon Repp - -- [How to Web Scrape Using Python, Snscrape & Custom Functions](https://hackernoon.com/how-to-web-scrape-using-python-snscrape-and-harperdb), by Davis David - -- [What’s the Big Deal w/ Custom Functions](https://rss.com/podcasts/harperdb-select-star/278933/), Select\* Podcast diff --git a/docs/developers/miscellaneous/google-data-studio.md b/docs/developers/miscellaneous/google-data-studio.md deleted file mode 100644 index 3d85f672..00000000 --- a/docs/developers/miscellaneous/google-data-studio.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Google Data Studio ---- - -# Google Data Studio - -[Google Data Studio](https://datastudio.google.com/) is a free collaborative visualization tool which enables users to build configurable charts and tables quickly. The Harper Google Data Studio connector seamlessly integrates your Harper data with Google Data Studio so you can build custom, real-time data visualizations. - -The Harper Google Data Studio Connector is subject to our [Terms of Use](https://harperdb.io/legal/harperdb-cloud-terms-of-service/) and [Privacy Policy](https://harperdb.io/legal/privacy-policy/). - -## Requirements - -The Harper database must be accessible through the Internet in order for Google Data Studio servers to access it. The database may be hosted by you or via [Harper Cloud](../../deployments/harper-cloud/). - -## Get Started - -Get started by selecting the Harper connector from the [Google Data Studio Partner Connector Gallery](https://datastudio.google.com/u/0/datasources/create). - -1. Log in to https://datastudio.google.com/. -1. Add a new Data Source using the Harper connector. The current release version can be added as a data source by following this link: [Harper Google Data Studio Connector](https://datastudio.google.com/datasources/create?connectorId=AKfycbxBKgF8FI5R42WVxO-QCOq7dmUys0HJrUJMkBQRoGnCasY60_VJeO3BhHJPvdd20-S76g). -1. Authorize the connector to access other servers on your behalf (this allows the connector to contact your database). -1. Enter the Web URL to access your database (preferably with HTTPS), as well as the Basic Auth key you use to access the database. Just include the key, not the word "Basic" at the start of it. -1. Check the box for "Secure Connections Only" if you want to always use HTTPS connections for this data source; entering a Web URL that starts with https:// will do the same thing, if you prefer. -1. Check the box for "Allow Bad Certs" if your Harper instance does not have a valid SSL certificate. [Harper Cloud](../../deployments/harper-cloud/) always has valid certificates, and so will never require this to be checked. Instances you set up yourself may require this, if you are using self-signed certs. If you are using [Harper Cloud](../../deployments/harper-cloud/) or another instance you know should always have valid SSL certificates, do not check this box. -1. Choose your Query Type. This determines what information the configuration will ask for after pressing the Next button. - - Table will ask you for a Schema and a Table to return all fields of using `SELECT *`. - - SQL will ask you for the SQL query you’re using to retrieve fields from the database. You may `JOIN` multiple tables together, and use Harper specific SQL functions, along with the usual power SQL grants. -1. When all information is entered correctly, press the Connect button in the top right of the new Data Source view to generate the Schema. You may also want to name the data source at this point. If the connector encounters any errors, a dialog box will tell you what went wrong so you can correct the issue. -1. If there are no errors, you now have a data source you can use in your reports! You may change the types of the generated fields in the Schema view if you need to (for instance, changing a Number field to a specific currency), as well as creating new fields from the report view that do calculations on other fields. - -## Considerations - -- Both Postman and the [Harper Studio](../../administration/harper-studio/) app have ways to convert a user:password pair to a Basic Auth token. Use either to create the token for the connector's user. - - You may sign out of your current user by going to the instances tab in Harper Studio, then clicking on the lock icon at the top-right of a given instance’s box. Click the lock again to sign in as any user. The Basic Auth token will be visible in the Authorization header portion of any code created in the Sample Code tab. -- It’s highly recommended that you create a read-only user role in Harper Studio, and create a user with that role for your data sources to use. This prevents that authorization token from being used to alter your database, should someone else ever get ahold of it. -- The RecordCount field is intended for use as a metric, for counting how many instances of a given set of values appear in a report’s data set. -- _Do not attempt to create fields with spaces in their names_ for any data sources! Google Data Studio will crash when attempting to retrieve a field with such a name, producing a System Error instead of a useful chart on your reports. Using CamelCase or snake_case gets around this. diff --git a/docs/developers/miscellaneous/index.md b/docs/developers/miscellaneous/index.md deleted file mode 100644 index f80dc499..00000000 --- a/docs/developers/miscellaneous/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Miscellaneous ---- - -# Miscellaneous - -This section covers a grouping of reference documents for various external developer tools, packages, SDKs, etc. diff --git a/docs/developers/miscellaneous/sdks.md b/docs/developers/miscellaneous/sdks.md deleted file mode 100644 index 20c066ce..00000000 --- a/docs/developers/miscellaneous/sdks.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: SDKs -description: >- - Software Development Kits available for connecting to Harper from different - languages. ---- - -# SDKs - -| SDK/Tool | Description | Installation | -| ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -| [HarperDB.NET.Client](https://www.nuget.org/packages/HarperDB.NET.Client) | A Dot Net Core client to execute operations against HarperDB | `dotnet add package HarperDB.NET.Client --version 1.1.0` | -| [Websocket Client](https://www.npmjs.com/package/harperdb-websocket-client) | A Javascript client for real-time access to HarperDB transactions | `npm i -s harperdb-websocket-client` | -| [Gatsby HarperDB Source](https://www.npmjs.com/package/gatsby-source-harperdb) | Use Harper as the data source for a Gatsby project at the build time | `npm i -s gatsby-source-harperdb` | -| [HarperDB.EntityFrameworkCore](https://www.nuget.org/packages/HarperDB.EntityFrameworkCore) | The Harper EntityFrameworkCore Provider Package for .NET 6.0 | `dotnet add package HarperDB.EntityFrameworkCore --version 1.0.0` | -| [Python SDK](https://pypi.org/project/harperdb/) | Python3 implementations of Harper API functions with wrappers for an object-oriented interface | `pip3 install harperdb` | -| [HarperDB Flutter SDK](https://github.com/HarperDB/harperdb-sdk-flutter) | A Harper SDK for Flutter | `flutter pub add harperdb` | -| [React Hook](https://www.npmjs.com/package/use-harperdb) | A ReactJS Hook for HarperDB | `npm i -s use-harperdb` | -| [Node Red Node](https://flows.nodered.org/node/node-red-contrib-harperdb) | Easy drag and drop connections to Harper using the Node-Red platform | `npm i -s node-red-contrib-harperdb` | -| [NodeJS SDK](https://www.npmjs.com/package/harperive) | A Harper SDK for NodeJS | `npm i -s harperive` | -| [HarperDB Cargo Crate](https://crates.io/crates/harperdb) | A Harper SDK for Rust | `Cargo.toml > harperdb = '1.0.0'` | -| [HarperDB Go SDK](https://github.com/HarperDB/sdk-go) | A Harper SDK for Go | `go get github.com/HarperDB/sdk-go` | diff --git a/docs/developers/miscellaneous/query-optimization.md b/docs/reference/resources/query-optimization.md similarity index 100% rename from docs/developers/miscellaneous/query-optimization.md rename to docs/reference/resources/query-optimization.md diff --git a/redirects.ts b/redirects.ts index 7fabdf84..8c311736 100644 --- a/redirects.ts +++ b/redirects.ts @@ -147,14 +147,6 @@ function generateDocsRedirects(basePath: string): RedirectRule[] { from: withBase('/custom-functions/debugging-custom-function'), to: withBase('/developers/applications/debugging'), }, - { from: withBase('/custom-functions/example-projects'), to: withBase('/developers/applications/example-projects') }, - - // Add-ons and SDKs - { from: withBase('/add-ons-and-sdks'), to: withBase('/developers/applications/') }, - { - from: withBase('/add-ons-and-sdks/google-data-studio'), - to: withBase('/developers/miscellaneous/google-data-studio'), - }, // SQL Guide { from: withBase('/sql-guide'), to: withBase('/developers/sql-guide/') }, diff --git a/versioned_docs/version-4.4/developers/applications/example-projects.md b/versioned_docs/version-4.4/developers/applications/example-projects.md deleted file mode 100644 index 3c2342a3..00000000 --- a/versioned_docs/version-4.4/developers/applications/example-projects.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Example Projects ---- - -# Example Projects - -**Library of example Harper applications and components:** - -- [Authorization in Harper using Okta Customer Identity Cloud](https://www.harperdb.io/post/authorization-in-harperdb-using-okta-customer-identity-cloud), by Yitaek Hwang - -- [How to Speed Up your Applications by Caching at the Edge with Harper](https://dev.to/doabledanny/how-to-speed-up-your-applications-by-caching-at-the-edge-with-harperdb-3o2l), by Danny Adams - -- [OAuth Authentication in Harper using Auth0 & Node.js](https://www.harperdb.io/post/oauth-authentication-in-harperdb-using-auth0-and-node-js), by Lucas Santos - -- [How To Create a CRUD API with Next.js & Harper Custom Functions](https://www.harperdb.io/post/create-a-crud-api-w-next-js-harperdb), by Colby Fayock - -- [Build a Dynamic REST API with Custom Functions](https://harperdb.io/blog/build-a-dynamic-rest-api-with-custom-functions/), by Terra Roush - -- [How to use Harper Custom Functions to Build your Entire Backend](https://dev.to/andrewbaisden/how-to-use-harperdb-custom-functions-to-build-your-entire-backend-a2m), by Andrew Baisden - -- [Using TensorFlowJS & Harper Custom Functions for Machine Learning](https://harperdb.io/blog/using-tensorflowjs-harperdb-for-machine-learning/), by Kevin Ashcraft - -- [Build & Deploy a Fitness App with Python & Harper](https://www.youtube.com/watch?v=KMkmA4i2FQc), by Patrick Löber - -- [Create a Discord Slash Bot using Harper Custom Functions](https://geekysrm.hashnode.dev/discord-slash-bot-with-harperdb-custom-functions), by Soumya Ranjan Mohanty - -- [How I used Harper Custom Functions to Build a Web App for my Newsletter](https://blog.hrithwik.me/how-i-used-harperdb-custom-functions-to-build-a-web-app-for-my-newsletter), by Hrithwik Bharadwaj - -- [How I used Harper Custom Functions and Recharts to create Dashboard](https://blog.greenroots.info/how-to-create-dashboard-with-harperdb-custom-functions-and-recharts), by Tapas Adhikary - -- [How To Use Harper Custom Functions With Your React App](https://dev.to/tyaga001/how-to-use-harperdb-custom-functions-with-your-react-app-2c43), by Ankur Tyagi - -- [Build a Web App Using Harper’s Custom Functions](https://www.youtube.com/watch?v=rz6prItVJZU), livestream by Jaxon Repp - -- [How to Web Scrape Using Python, Snscrape & Custom Functions](https://hackernoon.com/how-to-web-scrape-using-python-snscrape-and-harperdb), by Davis David - -- [What’s the Big Deal w/ Custom Functions](https://rss.com/podcasts/harperdb-select-star/278933/), Select\* Podcast diff --git a/versioned_docs/version-4.4/developers/miscellaneous/google-data-studio.md b/versioned_docs/version-4.4/developers/miscellaneous/google-data-studio.md deleted file mode 100644 index 7939417b..00000000 --- a/versioned_docs/version-4.4/developers/miscellaneous/google-data-studio.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Google Data Studio ---- - -# Google Data Studio - -[Google Data Studio](https://datastudio.google.com/) is a free collaborative visualization tool which enables users to build configurable charts and tables quickly. The Harper Google Data Studio connector seamlessly integrates your Harper data with Google Data Studio so you can build custom, real-time data visualizations. - -The Harper Google Data Studio Connector is subject to our [Terms of Use](https://harperdb.io/legal/harperdb-cloud-terms-of-service/) and [Privacy Policy](https://harperdb.io/legal/privacy-policy/). - -## Requirements - -The Harper database must be accessible through the Internet in order for Google Data Studio servers to access it. The database may be hosted by you or via [Harper Cloud](../../deployments/harper-cloud/). - -## Get Started - -Get started by selecting the Harper connector from the [Google Data Studio Partner Connector Gallery](https://datastudio.google.com/u/0/datasources/create). - -1. Log in to [https://datastudio.google.com/](https://datastudio.google.com/). -1. Add a new Data Source using the Harper connector. The current release version can be added as a data source by following this link: [Harper Google Data Studio Connector](https://datastudio.google.com/datasources/create?connectorId=AKfycbxBKgF8FI5R42WVxO-QCOq7dmUys0HJrUJMkBQRoGnCasY60_VJeO3BhHJPvdd20-S76g). -1. Authorize the connector to access other servers on your behalf (this allows the connector to contact your database). -1. Enter the Web URL to access your database (preferably with HTTPS), as well as the Basic Auth key you use to access the database. Just include the key, not the word "Basic" at the start of it. -1. Check the box for "Secure Connections Only" if you want to always use HTTPS connections for this data source; entering a Web URL that starts with https:// will do the same thing, if you prefer. -1. Check the box for "Allow Bad Certs" if your Harper instance does not have a valid SSL certificate. [Harper Cloud](../../deployments/harper-cloud/) always has valid certificates, and so will never require this to be checked. Instances you set up yourself may require this, if you are using self-signed certs. If you are using [Harper Cloud](../../deployments/harper-cloud/) or another instance you know should always have valid SSL certificates, do not check this box. -1. Choose your Query Type. This determines what information the configuration will ask for after pressing the Next button. - - Table will ask you for a Schema and a Table to return all fields of using `SELECT *`. - - SQL will ask you for the SQL query you’re using to retrieve fields from the database. You may `JOIN` multiple tables together, and use Harper specific SQL functions, along with the usual power SQL grants. -1. When all information is entered correctly, press the Connect button in the top right of the new Data Source view to generate the Schema. You may also want to name the data source at this point. If the connector encounters any errors, a dialog box will tell you what went wrong so you can correct the issue. -1. If there are no errors, you now have a data source you can use in your reports! You may change the types of the generated fields in the Schema view if you need to (for instance, changing a Number field to a specific currency), as well as creating new fields from the report view that do calculations on other fields. - -## Considerations - -- Both Postman and the [Harper Studio](../../deployments/harper-cloud/) app have ways to convert a user:password pair to a Basic Auth token. Use either to create the token for the connector’s user. - - You may sign out of your current user by going to the instances tab in Harper Studio, then clicking on the lock icon at the top-right of a given instance’s box. Click the lock again to sign in as any user. The Basic Auth token will be visible in the Authorization header portion of any code created in the Sample Code tab. -- It’s highly recommended that you create a read-only user role in Harper Studio, and create a user with that role for your data sources to use. This prevents that authorization token from being used to alter your database, should someone else ever get ahold of it. -- The RecordCount field is intended for use as a metric, for counting how many instances of a given set of values appear in a report’s data set. -- _Do not attempt to create fields with spaces in their names_ for any data sources! Google Data Studio will crash when attempting to retrieve a field with such a name, producing a System Error instead of a useful chart on your reports. Using CamelCase or snake_case gets around this. diff --git a/versioned_docs/version-4.4/developers/miscellaneous/index.md b/versioned_docs/version-4.4/developers/miscellaneous/index.md deleted file mode 100644 index f80dc499..00000000 --- a/versioned_docs/version-4.4/developers/miscellaneous/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Miscellaneous ---- - -# Miscellaneous - -This section covers a grouping of reference documents for various external developer tools, packages, SDKs, etc. diff --git a/versioned_docs/version-4.4/developers/miscellaneous/sdks.md b/versioned_docs/version-4.4/developers/miscellaneous/sdks.md deleted file mode 100644 index 2397c294..00000000 --- a/versioned_docs/version-4.4/developers/miscellaneous/sdks.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: SDKs -description: >- - Software Development Kits available for connecting to Harper from different - languages. ---- - -# SDKs - -| SDK/Tool | Description | Installation | -| ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -| [HarperDB.NET.Client](https://www.nuget.org/packages/HarperDB.NET.Client) | A Dot Net Core client to execute operations against HarperDB | `dotnet add package HarperDB.NET.Client --version 1.1.0` | -| [Websocket Client](https://www.npmjs.com/package/harperdb-websocket-client) | A Javascript client for real-time access to HarperDB transactions | `npm i -s harperdb-websocket-client` | -| [Gatsby HarperDB Source](https://www.npmjs.com/package/gatsby-source-harperdb) | Use Harper as the data source for a Gatsby project at the build time | `npm i -s gatsby-source-harperdb` | -| [HarperDB.EntityFrameworkCore](https://www.nuget.org/packages/HarperDB.EntityFrameworkCore) | The Harper EntityFrameworkCore Provider Package for .NET 6.0 | `dotnet add package HarperDB.EntityFrameworkCore --version 1.0.0` | -| [Python SDK](https://pypi.org/project/harperdb/) | Python3 implementations of Harper API functions with wrappers for an object-oriented interface | `pip3 install harperdb` | -| [HarperDB Flutter SDK](https://github.com/HarperDB/harperdb-sdk-flutter) | A Harper SDK for Flutter | `flutter pub add harperdb` | -| [React Hook](https://www.npmjs.com/package/use-harperdb) | A ReactJS Hook for HarperDB | `npm i -s use-harperdb` | -| [Node Red Node](https://flows.nodered.org/node/node-red-contrib-harperdb) | Easy drag and drop connections to Harper using the Node-Red platform | `npm i -s node-red-contrib-harperdb` | -| [NodeJS SDK](https://www.npmjs.com/package/harperive) | A Harper SDK for NodeJS | `npm i -s harperive` | -| [HarperDB Cargo Crate](https://crates.io/crates/harperdb) | A Harper SDK for Rust | `Cargo.toml > harperdb = '1.0.0'` | -| [HarperDB Go SDK](https://github.com/HarperDB-Add-Ons/sdk-go) | A Harper SDK for Go | `go get github.com/HarperDB-Add-Ons/sdk-go` | diff --git a/versioned_docs/version-4.4/developers/miscellaneous/query-optimization.md b/versioned_docs/version-4.4/reference/query-optimization.md similarity index 100% rename from versioned_docs/version-4.4/developers/miscellaneous/query-optimization.md rename to versioned_docs/version-4.4/reference/query-optimization.md diff --git a/versioned_docs/version-4.5/developers/applications/example-projects.md b/versioned_docs/version-4.5/developers/applications/example-projects.md deleted file mode 100644 index 3c2342a3..00000000 --- a/versioned_docs/version-4.5/developers/applications/example-projects.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Example Projects ---- - -# Example Projects - -**Library of example Harper applications and components:** - -- [Authorization in Harper using Okta Customer Identity Cloud](https://www.harperdb.io/post/authorization-in-harperdb-using-okta-customer-identity-cloud), by Yitaek Hwang - -- [How to Speed Up your Applications by Caching at the Edge with Harper](https://dev.to/doabledanny/how-to-speed-up-your-applications-by-caching-at-the-edge-with-harperdb-3o2l), by Danny Adams - -- [OAuth Authentication in Harper using Auth0 & Node.js](https://www.harperdb.io/post/oauth-authentication-in-harperdb-using-auth0-and-node-js), by Lucas Santos - -- [How To Create a CRUD API with Next.js & Harper Custom Functions](https://www.harperdb.io/post/create-a-crud-api-w-next-js-harperdb), by Colby Fayock - -- [Build a Dynamic REST API with Custom Functions](https://harperdb.io/blog/build-a-dynamic-rest-api-with-custom-functions/), by Terra Roush - -- [How to use Harper Custom Functions to Build your Entire Backend](https://dev.to/andrewbaisden/how-to-use-harperdb-custom-functions-to-build-your-entire-backend-a2m), by Andrew Baisden - -- [Using TensorFlowJS & Harper Custom Functions for Machine Learning](https://harperdb.io/blog/using-tensorflowjs-harperdb-for-machine-learning/), by Kevin Ashcraft - -- [Build & Deploy a Fitness App with Python & Harper](https://www.youtube.com/watch?v=KMkmA4i2FQc), by Patrick Löber - -- [Create a Discord Slash Bot using Harper Custom Functions](https://geekysrm.hashnode.dev/discord-slash-bot-with-harperdb-custom-functions), by Soumya Ranjan Mohanty - -- [How I used Harper Custom Functions to Build a Web App for my Newsletter](https://blog.hrithwik.me/how-i-used-harperdb-custom-functions-to-build-a-web-app-for-my-newsletter), by Hrithwik Bharadwaj - -- [How I used Harper Custom Functions and Recharts to create Dashboard](https://blog.greenroots.info/how-to-create-dashboard-with-harperdb-custom-functions-and-recharts), by Tapas Adhikary - -- [How To Use Harper Custom Functions With Your React App](https://dev.to/tyaga001/how-to-use-harperdb-custom-functions-with-your-react-app-2c43), by Ankur Tyagi - -- [Build a Web App Using Harper’s Custom Functions](https://www.youtube.com/watch?v=rz6prItVJZU), livestream by Jaxon Repp - -- [How to Web Scrape Using Python, Snscrape & Custom Functions](https://hackernoon.com/how-to-web-scrape-using-python-snscrape-and-harperdb), by Davis David - -- [What’s the Big Deal w/ Custom Functions](https://rss.com/podcasts/harperdb-select-star/278933/), Select\* Podcast diff --git a/versioned_docs/version-4.5/developers/miscellaneous/google-data-studio.md b/versioned_docs/version-4.5/developers/miscellaneous/google-data-studio.md deleted file mode 100644 index 7939417b..00000000 --- a/versioned_docs/version-4.5/developers/miscellaneous/google-data-studio.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Google Data Studio ---- - -# Google Data Studio - -[Google Data Studio](https://datastudio.google.com/) is a free collaborative visualization tool which enables users to build configurable charts and tables quickly. The Harper Google Data Studio connector seamlessly integrates your Harper data with Google Data Studio so you can build custom, real-time data visualizations. - -The Harper Google Data Studio Connector is subject to our [Terms of Use](https://harperdb.io/legal/harperdb-cloud-terms-of-service/) and [Privacy Policy](https://harperdb.io/legal/privacy-policy/). - -## Requirements - -The Harper database must be accessible through the Internet in order for Google Data Studio servers to access it. The database may be hosted by you or via [Harper Cloud](../../deployments/harper-cloud/). - -## Get Started - -Get started by selecting the Harper connector from the [Google Data Studio Partner Connector Gallery](https://datastudio.google.com/u/0/datasources/create). - -1. Log in to [https://datastudio.google.com/](https://datastudio.google.com/). -1. Add a new Data Source using the Harper connector. The current release version can be added as a data source by following this link: [Harper Google Data Studio Connector](https://datastudio.google.com/datasources/create?connectorId=AKfycbxBKgF8FI5R42WVxO-QCOq7dmUys0HJrUJMkBQRoGnCasY60_VJeO3BhHJPvdd20-S76g). -1. Authorize the connector to access other servers on your behalf (this allows the connector to contact your database). -1. Enter the Web URL to access your database (preferably with HTTPS), as well as the Basic Auth key you use to access the database. Just include the key, not the word "Basic" at the start of it. -1. Check the box for "Secure Connections Only" if you want to always use HTTPS connections for this data source; entering a Web URL that starts with https:// will do the same thing, if you prefer. -1. Check the box for "Allow Bad Certs" if your Harper instance does not have a valid SSL certificate. [Harper Cloud](../../deployments/harper-cloud/) always has valid certificates, and so will never require this to be checked. Instances you set up yourself may require this, if you are using self-signed certs. If you are using [Harper Cloud](../../deployments/harper-cloud/) or another instance you know should always have valid SSL certificates, do not check this box. -1. Choose your Query Type. This determines what information the configuration will ask for after pressing the Next button. - - Table will ask you for a Schema and a Table to return all fields of using `SELECT *`. - - SQL will ask you for the SQL query you’re using to retrieve fields from the database. You may `JOIN` multiple tables together, and use Harper specific SQL functions, along with the usual power SQL grants. -1. When all information is entered correctly, press the Connect button in the top right of the new Data Source view to generate the Schema. You may also want to name the data source at this point. If the connector encounters any errors, a dialog box will tell you what went wrong so you can correct the issue. -1. If there are no errors, you now have a data source you can use in your reports! You may change the types of the generated fields in the Schema view if you need to (for instance, changing a Number field to a specific currency), as well as creating new fields from the report view that do calculations on other fields. - -## Considerations - -- Both Postman and the [Harper Studio](../../deployments/harper-cloud/) app have ways to convert a user:password pair to a Basic Auth token. Use either to create the token for the connector’s user. - - You may sign out of your current user by going to the instances tab in Harper Studio, then clicking on the lock icon at the top-right of a given instance’s box. Click the lock again to sign in as any user. The Basic Auth token will be visible in the Authorization header portion of any code created in the Sample Code tab. -- It’s highly recommended that you create a read-only user role in Harper Studio, and create a user with that role for your data sources to use. This prevents that authorization token from being used to alter your database, should someone else ever get ahold of it. -- The RecordCount field is intended for use as a metric, for counting how many instances of a given set of values appear in a report’s data set. -- _Do not attempt to create fields with spaces in their names_ for any data sources! Google Data Studio will crash when attempting to retrieve a field with such a name, producing a System Error instead of a useful chart on your reports. Using CamelCase or snake_case gets around this. diff --git a/versioned_docs/version-4.5/developers/miscellaneous/index.md b/versioned_docs/version-4.5/developers/miscellaneous/index.md deleted file mode 100644 index f80dc499..00000000 --- a/versioned_docs/version-4.5/developers/miscellaneous/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Miscellaneous ---- - -# Miscellaneous - -This section covers a grouping of reference documents for various external developer tools, packages, SDKs, etc. diff --git a/versioned_docs/version-4.5/developers/miscellaneous/sdks.md b/versioned_docs/version-4.5/developers/miscellaneous/sdks.md deleted file mode 100644 index 2397c294..00000000 --- a/versioned_docs/version-4.5/developers/miscellaneous/sdks.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: SDKs -description: >- - Software Development Kits available for connecting to Harper from different - languages. ---- - -# SDKs - -| SDK/Tool | Description | Installation | -| ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -| [HarperDB.NET.Client](https://www.nuget.org/packages/HarperDB.NET.Client) | A Dot Net Core client to execute operations against HarperDB | `dotnet add package HarperDB.NET.Client --version 1.1.0` | -| [Websocket Client](https://www.npmjs.com/package/harperdb-websocket-client) | A Javascript client for real-time access to HarperDB transactions | `npm i -s harperdb-websocket-client` | -| [Gatsby HarperDB Source](https://www.npmjs.com/package/gatsby-source-harperdb) | Use Harper as the data source for a Gatsby project at the build time | `npm i -s gatsby-source-harperdb` | -| [HarperDB.EntityFrameworkCore](https://www.nuget.org/packages/HarperDB.EntityFrameworkCore) | The Harper EntityFrameworkCore Provider Package for .NET 6.0 | `dotnet add package HarperDB.EntityFrameworkCore --version 1.0.0` | -| [Python SDK](https://pypi.org/project/harperdb/) | Python3 implementations of Harper API functions with wrappers for an object-oriented interface | `pip3 install harperdb` | -| [HarperDB Flutter SDK](https://github.com/HarperDB/harperdb-sdk-flutter) | A Harper SDK for Flutter | `flutter pub add harperdb` | -| [React Hook](https://www.npmjs.com/package/use-harperdb) | A ReactJS Hook for HarperDB | `npm i -s use-harperdb` | -| [Node Red Node](https://flows.nodered.org/node/node-red-contrib-harperdb) | Easy drag and drop connections to Harper using the Node-Red platform | `npm i -s node-red-contrib-harperdb` | -| [NodeJS SDK](https://www.npmjs.com/package/harperive) | A Harper SDK for NodeJS | `npm i -s harperive` | -| [HarperDB Cargo Crate](https://crates.io/crates/harperdb) | A Harper SDK for Rust | `Cargo.toml > harperdb = '1.0.0'` | -| [HarperDB Go SDK](https://github.com/HarperDB-Add-Ons/sdk-go) | A Harper SDK for Go | `go get github.com/HarperDB-Add-Ons/sdk-go` | diff --git a/versioned_docs/version-4.5/developers/miscellaneous/query-optimization.md b/versioned_docs/version-4.5/reference/query-optimization.md similarity index 100% rename from versioned_docs/version-4.5/developers/miscellaneous/query-optimization.md rename to versioned_docs/version-4.5/reference/query-optimization.md diff --git a/versioned_docs/version-4.6/developers/applications/example-projects.md b/versioned_docs/version-4.6/developers/applications/example-projects.md deleted file mode 100644 index 3c2342a3..00000000 --- a/versioned_docs/version-4.6/developers/applications/example-projects.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Example Projects ---- - -# Example Projects - -**Library of example Harper applications and components:** - -- [Authorization in Harper using Okta Customer Identity Cloud](https://www.harperdb.io/post/authorization-in-harperdb-using-okta-customer-identity-cloud), by Yitaek Hwang - -- [How to Speed Up your Applications by Caching at the Edge with Harper](https://dev.to/doabledanny/how-to-speed-up-your-applications-by-caching-at-the-edge-with-harperdb-3o2l), by Danny Adams - -- [OAuth Authentication in Harper using Auth0 & Node.js](https://www.harperdb.io/post/oauth-authentication-in-harperdb-using-auth0-and-node-js), by Lucas Santos - -- [How To Create a CRUD API with Next.js & Harper Custom Functions](https://www.harperdb.io/post/create-a-crud-api-w-next-js-harperdb), by Colby Fayock - -- [Build a Dynamic REST API with Custom Functions](https://harperdb.io/blog/build-a-dynamic-rest-api-with-custom-functions/), by Terra Roush - -- [How to use Harper Custom Functions to Build your Entire Backend](https://dev.to/andrewbaisden/how-to-use-harperdb-custom-functions-to-build-your-entire-backend-a2m), by Andrew Baisden - -- [Using TensorFlowJS & Harper Custom Functions for Machine Learning](https://harperdb.io/blog/using-tensorflowjs-harperdb-for-machine-learning/), by Kevin Ashcraft - -- [Build & Deploy a Fitness App with Python & Harper](https://www.youtube.com/watch?v=KMkmA4i2FQc), by Patrick Löber - -- [Create a Discord Slash Bot using Harper Custom Functions](https://geekysrm.hashnode.dev/discord-slash-bot-with-harperdb-custom-functions), by Soumya Ranjan Mohanty - -- [How I used Harper Custom Functions to Build a Web App for my Newsletter](https://blog.hrithwik.me/how-i-used-harperdb-custom-functions-to-build-a-web-app-for-my-newsletter), by Hrithwik Bharadwaj - -- [How I used Harper Custom Functions and Recharts to create Dashboard](https://blog.greenroots.info/how-to-create-dashboard-with-harperdb-custom-functions-and-recharts), by Tapas Adhikary - -- [How To Use Harper Custom Functions With Your React App](https://dev.to/tyaga001/how-to-use-harperdb-custom-functions-with-your-react-app-2c43), by Ankur Tyagi - -- [Build a Web App Using Harper’s Custom Functions](https://www.youtube.com/watch?v=rz6prItVJZU), livestream by Jaxon Repp - -- [How to Web Scrape Using Python, Snscrape & Custom Functions](https://hackernoon.com/how-to-web-scrape-using-python-snscrape-and-harperdb), by Davis David - -- [What’s the Big Deal w/ Custom Functions](https://rss.com/podcasts/harperdb-select-star/278933/), Select\* Podcast diff --git a/versioned_docs/version-4.6/developers/miscellaneous/google-data-studio.md b/versioned_docs/version-4.6/developers/miscellaneous/google-data-studio.md deleted file mode 100644 index 95a912f3..00000000 --- a/versioned_docs/version-4.6/developers/miscellaneous/google-data-studio.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Google Data Studio ---- - -# Google Data Studio - -[Google Data Studio](https://datastudio.google.com/) is a free collaborative visualization tool which enables users to build configurable charts and tables quickly. The Harper Google Data Studio connector seamlessly integrates your Harper data with Google Data Studio so you can build custom, real-time data visualizations. - -The Harper Google Data Studio Connector is subject to our [Terms of Use](https://harperdb.io/legal/harperdb-cloud-terms-of-service/) and [Privacy Policy](https://harperdb.io/legal/privacy-policy/). - -## Requirements - -The Harper database must be accessible through the Internet in order for Google Data Studio servers to access it. The database may be hosted by you or via [Harper Cloud](../../deployments/harper-cloud/). - -## Get Started - -Get started by selecting the Harper connector from the [Google Data Studio Partner Connector Gallery](https://datastudio.google.com/u/0/datasources/create). - -1. Log in to [https://datastudio.google.com/](https://datastudio.google.com/). -1. Add a new Data Source using the Harper connector. The current release version can be added as a data source by following this link: [Harper Google Data Studio Connector](https://datastudio.google.com/datasources/create?connectorId=AKfycbxBKgF8FI5R42WVxO-QCOq7dmUys0HJrUJMkBQRoGnCasY60_VJeO3BhHJPvdd20-S76g). -1. Authorize the connector to access other servers on your behalf (this allows the connector to contact your database). -1. Enter the Web URL to access your database (preferably with HTTPS), as well as the Basic Auth key you use to access the database. Just include the key, not the word "Basic" at the start of it. -1. Check the box for "Secure Connections Only" if you want to always use HTTPS connections for this data source; entering a Web URL that starts with https:// will do the same thing, if you prefer. -1. Check the box for "Allow Bad Certs" if your Harper instance does not have a valid SSL certificate. [Harper Cloud](../../deployments/harper-cloud/) always has valid certificates, and so will never require this to be checked. Instances you set up yourself may require this, if you are using self-signed certs. If you are using [Harper Cloud](../../deployments/harper-cloud/) or another instance you know should always have valid SSL certificates, do not check this box. -1. Choose your Query Type. This determines what information the configuration will ask for after pressing the Next button. - - Table will ask you for a Schema and a Table to return all fields of using `SELECT *`. - - SQL will ask you for the SQL query you’re using to retrieve fields from the database. You may `JOIN` multiple tables together, and use Harper specific SQL functions, along with the usual power SQL grants. -1. When all information is entered correctly, press the Connect button in the top right of the new Data Source view to generate the Schema. You may also want to name the data source at this point. If the connector encounters any errors, a dialog box will tell you what went wrong so you can correct the issue. -1. If there are no errors, you now have a data source you can use in your reports! You may change the types of the generated fields in the Schema view if you need to (for instance, changing a Number field to a specific currency), as well as creating new fields from the report view that do calculations on other fields. - -## Considerations - -- Both Postman and the [Harper Studio](../../administration/harper-studio/) app have ways to convert a user:password pair to a Basic Auth token. Use either to create the token for the connector's user. - - You may sign out of your current user by going to the instances tab in Harper Studio, then clicking on the lock icon at the top-right of a given instance’s box. Click the lock again to sign in as any user. The Basic Auth token will be visible in the Authorization header portion of any code created in the Sample Code tab. -- It’s highly recommended that you create a read-only user role in Harper Studio, and create a user with that role for your data sources to use. This prevents that authorization token from being used to alter your database, should someone else ever get ahold of it. -- The RecordCount field is intended for use as a metric, for counting how many instances of a given set of values appear in a report’s data set. -- _Do not attempt to create fields with spaces in their names_ for any data sources! Google Data Studio will crash when attempting to retrieve a field with such a name, producing a System Error instead of a useful chart on your reports. Using CamelCase or snake_case gets around this. diff --git a/versioned_docs/version-4.6/developers/miscellaneous/index.md b/versioned_docs/version-4.6/developers/miscellaneous/index.md deleted file mode 100644 index f80dc499..00000000 --- a/versioned_docs/version-4.6/developers/miscellaneous/index.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -title: Miscellaneous ---- - -# Miscellaneous - -This section covers a grouping of reference documents for various external developer tools, packages, SDKs, etc. diff --git a/versioned_docs/version-4.6/developers/miscellaneous/sdks.md b/versioned_docs/version-4.6/developers/miscellaneous/sdks.md deleted file mode 100644 index 20c066ce..00000000 --- a/versioned_docs/version-4.6/developers/miscellaneous/sdks.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: SDKs -description: >- - Software Development Kits available for connecting to Harper from different - languages. ---- - -# SDKs - -| SDK/Tool | Description | Installation | -| ------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | -| [HarperDB.NET.Client](https://www.nuget.org/packages/HarperDB.NET.Client) | A Dot Net Core client to execute operations against HarperDB | `dotnet add package HarperDB.NET.Client --version 1.1.0` | -| [Websocket Client](https://www.npmjs.com/package/harperdb-websocket-client) | A Javascript client for real-time access to HarperDB transactions | `npm i -s harperdb-websocket-client` | -| [Gatsby HarperDB Source](https://www.npmjs.com/package/gatsby-source-harperdb) | Use Harper as the data source for a Gatsby project at the build time | `npm i -s gatsby-source-harperdb` | -| [HarperDB.EntityFrameworkCore](https://www.nuget.org/packages/HarperDB.EntityFrameworkCore) | The Harper EntityFrameworkCore Provider Package for .NET 6.0 | `dotnet add package HarperDB.EntityFrameworkCore --version 1.0.0` | -| [Python SDK](https://pypi.org/project/harperdb/) | Python3 implementations of Harper API functions with wrappers for an object-oriented interface | `pip3 install harperdb` | -| [HarperDB Flutter SDK](https://github.com/HarperDB/harperdb-sdk-flutter) | A Harper SDK for Flutter | `flutter pub add harperdb` | -| [React Hook](https://www.npmjs.com/package/use-harperdb) | A ReactJS Hook for HarperDB | `npm i -s use-harperdb` | -| [Node Red Node](https://flows.nodered.org/node/node-red-contrib-harperdb) | Easy drag and drop connections to Harper using the Node-Red platform | `npm i -s node-red-contrib-harperdb` | -| [NodeJS SDK](https://www.npmjs.com/package/harperive) | A Harper SDK for NodeJS | `npm i -s harperive` | -| [HarperDB Cargo Crate](https://crates.io/crates/harperdb) | A Harper SDK for Rust | `Cargo.toml > harperdb = '1.0.0'` | -| [HarperDB Go SDK](https://github.com/HarperDB/sdk-go) | A Harper SDK for Go | `go get github.com/HarperDB/sdk-go` | diff --git a/versioned_docs/version-4.6/developers/miscellaneous/query-optimization.md b/versioned_docs/version-4.6/reference/resources/query-optimization.md similarity index 100% rename from versioned_docs/version-4.6/developers/miscellaneous/query-optimization.md rename to versioned_docs/version-4.6/reference/resources/query-optimization.md