Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

SQL Proxy Docs #11397

Closed
wants to merge 16 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
9 changes: 9 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,12 @@ node_modules
package-lock.json
pnpm-lock.yaml
platform/dist
*.md
*.mdx
*.txt
*.yml
*.yaml
*.lock
*.py
*.png

2 changes: 1 addition & 1 deletion .github/actions/git-diff-on-components/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This action takes care of all components with dependencies that were modified bu

### `all_files`

**Required** List of all files comming from `changed_files` step in `check_version` job github action workflow. It is necessary to set the action `jitterbit/get-changed-files@v1` output in json format like
**Required** List of all files comming from `changed_files` step in `check_version` job github action workflow. It is necessary to set the action `Ana06/get-changed-files@v2.3.0` output in json format like
```
...
with:
Expand Down
16 changes: 8 additions & 8 deletions .github/workflows/components-pr.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
pull-requests: write

steps:
- uses: actions/checkout@v4.1.4
- uses: actions/checkout@v4.1.6
name: Checkout repo
with:
# See https://github.com/actions/checkout#checkout-v2
Expand All @@ -30,7 +30,7 @@ jobs:
# we have to fetch the entire history. See
# https://github.com/actions/checkout/issues/266#issuecomment-638346893
fetch-depth: 0
- uses: jitterbit/get-changed-files@v1
- uses: Ana06/get-changed-files@v2.3.0
id: changed_files
name: Get changed files
with:
Expand All @@ -48,8 +48,8 @@ jobs:

steps:
- name: Checkout code
uses: actions/checkout@v4.1.4
- uses: pnpm/action-setup@v3.0.0
uses: actions/checkout@v4.1.6
- uses: pnpm/action-setup@v4.0.0
with:
version: 7.33.6
- name: Get pnpm store directory
Expand All @@ -76,7 +76,7 @@ jobs:
run: npm run build > files.txt
- name: Get Changed Files
id: files
uses: jitterbit/get-changed-files@v1
uses: Ana06/get-changed-files@v2.3.0
with:
format: 'csv'
- name: Check For Compiled TypeScript Files
Expand Down Expand Up @@ -137,8 +137,8 @@ jobs:

steps:
- name: Checkout code
uses: actions/checkout@v4.1.4
- uses: pnpm/action-setup@v3.0.0
uses: actions/checkout@v4.1.6
- uses: pnpm/action-setup@v4.0.0
with:
version: 7.33.6
- name: Get pnpm store directory
Expand All @@ -165,7 +165,7 @@ jobs:
run: npm run build > files.txt
- name: Get Changed Files
id: files
uses: jitterbit/get-changed-files@v1
uses: Ana06/get-changed-files@v2.3.0
with:
format: 'csv'
- name: Publish TypeScript components (dry run)
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4.1.4
- uses: actions/checkout@v4.1.6
name: Checkout repo
with:
# See https://github.com/actions/checkout#checkout-v2
Expand Down
12 changes: 6 additions & 6 deletions .github/workflows/publish-components.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4.1.4
- uses: pnpm/action-setup@v3.0.0
uses: actions/checkout@v4.1.6
- uses: pnpm/action-setup@v4.0.0
with:
version: 7.33.6
- name: Get pnpm store directory
Expand Down Expand Up @@ -48,7 +48,7 @@ jobs:
echo "org_id = $PD_ORG_ID" >> $HOME/.config/pipedream/config
- name: Get Changed Files
id: files
uses: jitterbit/get-changed-files@v1
uses: Ana06/get-changed-files@v2.3.0
with:
format: 'csv'
- name: Publish and add to registry components/*.*js (that aren't .app.js files)
Expand Down Expand Up @@ -117,8 +117,8 @@ jobs:

steps:
- name: Checkout code
uses: actions/checkout@v4.1.4
- uses: pnpm/action-setup@v3.0.0
uses: actions/checkout@v4.1.6
- uses: pnpm/action-setup@v4.0.0
with:
version: 7.33.6
- name: Get pnpm store directory
Expand Down Expand Up @@ -155,7 +155,7 @@ jobs:
run: npm run build > files.txt
- name: Get Changed Files
id: files
uses: jitterbit/get-changed-files@v1
uses: Ana06/get-changed-files@v2.3.0
with:
format: 'csv'
- name: Publish TypeScript components (dry run)
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/publish-marketplace-content.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4.1.4
- uses: pnpm/action-setup@v3.0.0
uses: actions/checkout@v4.1.6
- uses: pnpm/action-setup@v4.0.0
with:
version: 7.33.6
- name: Get pnpm store directory
Expand All @@ -36,7 +36,7 @@ jobs:
cache: 'pnpm'
- name: Get Changed Files
id: files
uses: jitterbit/get-changed-files@v1
uses: Ana06/get-changed-files@v2.3.0
with:
format: 'csv'
- name: Publish changes to marketplace content
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/publish-packages.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ jobs:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- uses: actions/checkout@v4.1.4
- uses: pnpm/action-setup@v3.0.0
- uses: actions/checkout@v4.1.6
- uses: pnpm/action-setup@v4.0.0
with:
version: 7.33.6
- name: Get pnpm store directory
Expand Down
14 changes: 7 additions & 7 deletions .github/workflows/pull-request-checks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4.1.4
- uses: actions/checkout@v4.1.6
name: Checkout
- uses: jitterbit/get-changed-files@v1
- uses: Ana06/get-changed-files@v2.3.0
id: changed_files
name: Get changed files
- id: md_changed_files
Expand Down Expand Up @@ -48,12 +48,12 @@ jobs:

steps:
- name: Checkout Code
uses: actions/checkout@v4.1.4
uses: actions/checkout@v4.1.6
with:
# Full git history is needed to get a proper list of changed files
# within `super-linter`
fetch-depth: 0
- uses: pnpm/action-setup@v3.0.0
- uses: pnpm/action-setup@v4.0.0
with:
version: 7.33.6
- name: Get pnpm store directory
Expand Down Expand Up @@ -90,14 +90,14 @@ jobs:
# ESLint only on changed files (not the same as the above super-linter)
- name: Get Changed Files (space-separated)
id: changed_files_space
uses: jitterbit/get-changed-files@v1
uses: Ana06/get-changed-files@v2.3.0
with:
format: 'space-delimited'
- name: Lint changed files
run: npx eslint ${{ steps.changed_files_space.outputs.added_modified }} ${{ steps.changed_files_space.outputs.renamed }}
run: npx eslint --quiet ${{ steps.changed_files_space.outputs.added_modified }} ${{ steps.changed_files_space.outputs.renamed }}
- name: Get Changed Files (comma-separated)
id: changed_files
uses: jitterbit/get-changed-files@v1
uses: Ana06/get-changed-files@v2.3.0
with:
format: 'csv'
# NOTE: These steps are kept in this workflow to avoid re-rerunning the rest of the lint job
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Click the image below to watch a brief demo on YouTube.

<p align="center">
<br />
<a href="https://bit.ly/36fwHWs">
<a href="https://bit.ly/3ytGgyR">
<img src="./images/demo.png" width="800px" alt="Pipedream demo static image" />
</a>
</p>
Expand Down
12 changes: 6 additions & 6 deletions blog/pi/poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
import { defineApp } from "@pipedream/types";

export default defineApp({
export default {
type: "app",
app: "hotmart",
app: "appwrite",
propDefinitions: {},
methods: {
// this.$auth contains connected account data
authKeys() {
console.log(Object.keys(this.$auth));
},
},
});
};
15 changes: 15 additions & 0 deletions components/appwrite/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"name": "@pipedream/appwrite",
"version": "0.0.1",
"description": "Pipedream Appwrite Components",
"main": "appwrite.app.mjs",
"keywords": [
"pipedream",
"appwrite"
],
"homepage": "https://pipedream.com/apps/appwrite",
"author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
"publishConfig": {
"access": "public"
}
}
45 changes: 45 additions & 0 deletions components/aws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,51 @@

The AWS API unlocks endless possibilities for automation with Pipedream. With this powerful combo, you can manage your AWS services and resources, automate deployment workflows, process data, and react to events across your AWS infrastructure. Pipedream offers a serverless platform for creating workflows triggered by various events that can execute AWS SDK functions, making it an efficient tool to integrate, automate, and orchestrate tasks across AWS services and other apps.

# Getting Started

To get started, first [log in to the AWS console](https://signin.aws.amazon.com/signin).

Once you've logged in, navigate to the Identity and Access Management (IAM) service. Then click the **Users** section:

![Open the users management area in the AWS IAM service](https://res.cloudinary.com/pipedreamin/image/upload/v1715097590/marketplace/apps/aws/CleanShot_2024-05-07_at_11.59.24_mgqvr5.png)

From within the users management section, create a new user by clicking **Create User** in the top right:

![Creating a new user from within the AWS IAM console](https://res.cloudinary.com/pipedreamin/image/upload/v1715097847/marketplace/apps/aws/CleanShot_2024-05-07_at_12.03.52_rm4kae.png)

On the next page, you'll be prompted to name the user. We recommend naming the user `pipedream` so you can easily remember which service this user is tied to:

![Naming the new IAM user](https://res.cloudinary.com/pipedreamin/image/upload/v1715097913/marketplace/apps/aws/CleanShot_2024-05-07_at_12.04.30_acgthh.png)

Next, you'll be prompted to define this user's *permissions*. You have three options:
1. Attach the user to a group - the new user will inherit the group's permission policies.
2. Copy permissions - copy the permission policies from another existing IAM user.
3. Attach policies directly - attach a policy directly to the new user.

If you're unfamiliar with defining permissions in AWS, consider using a pre-made permission policy. For example, if you need Pipedream to integrate with S3, you can choose the `S3FullAccessPolicy` by searching for "s3" in the search bar:

![Searching for s3 in the permissions search bar within IAM to attach the S3FullAccessPolicy directly to the pipedream user](https://res.cloudinary.com/pipedreamin/image/upload/v1715098770/marketplace/apps/aws/CleanShot_2024-05-07_at_12.19.01_zwgldj.png)

Alternatively, you can craft specific policies within IAM that only grant specific access to specific AWS resources to this new `pipedream` user.

Click **Create Policy** to create a new custom policy, and from within this view, you can use either JSON or the UI to include permissions to specific services and resources.

After you’ve created your IAM user, it will display a **Client Key** and **Secret**. Copy these fields into Pipedream to connect your AWS account.

Please note, the AWS Client Secret will not be shown again after closing the window. So make sure that your credentials are properly copied into Pipedream before closing the IAM window.

# Troubleshooting

## Permissions issues

The most common issue when integrating Pipedream with AWS is permissions issues.

The IAM user you create for Pipedream must have access to the AWS resources it’s attempting to use within your triggers, actions, Node.js, or Python code steps.

You can use the AWS IAM console to attach additional policies to your IAM user associated with Pipedream.



# Example Use Cases

- **Automated Backup to S3**: Trigger a workflow when a new row is added to a Google Sheets document, process the data within Pipedream, and automatically back it up to an AWS S3 bucket. This ensures important data is stored safely without manual intervention.
Expand Down
11 changes: 11 additions & 0 deletions components/bilflo/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Overview

The Bilflo API allows users to automate and integrate staffing and workforce management processes. By connecting Bilflo with Pipedream, users can streamline data flows between Bilflo and other business applications, enabling automated reporting, payroll processing, and seamless data synchronization across platforms. This integration can significantly enhance operational efficiencies, reduce manual data entry, and provide real-time analytics for better decision-making.

# Example Use Cases

- **Automated Payroll Processing**: Set up a workflow on Pipedream where hours logged in Bilflo are automatically pushed to a payroll system like ADP or Paychex. When an employee submits their timesheet, the workflow triggers, validates the data, and sends it to the payroll app, ensuring timely and accurate payroll execution.

- **Real-time Staffing Updates to CRM**: Create a workflow that syncs new employee details or updates from Bilflo to a CRM platform such as Salesforce. Whenever there is a new hire or an update in employee status in Bilflo, the workflow automatically updates the corresponding records in Salesforce, keeping sales and service teams informed about staffing changes.

- **Automated Compliance Reporting**: Develop a workflow where employee data from Bilflo is used to automatically generate compliance reports. This workflow could connect Bilflo to a document generation tool like Google Docs or an analytics tool like Tableau, compiling necessary compliance information and creating reports at regular intervals or on demand.
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import bilflo from "../../bilflo.app.mjs";

export default {
key: "bilflo-assign-contract-job-to-invoice",
name: "Assign Contract Job to Invoice Group",
description: "Assigns a contract job to a specified invoice group for a client. [See the documentation](https://developer.bilflo.com/documentation#operations-tag-Clients)",
version: "0.0.1",
type: "action",
props: {
bilflo,
jobId: {
type: "integer",
label: "Contract Job Identifier",
description: "The unique identifier for the contract job.",
},
invoiceGroupId: {
type: "integer",
label: "Invoice Group Identifier",
description: "The unique identifier for the invoice group.",
},
},
async run({ $ }) {
const response = await this.bilflo.assignContractJobToInvoiceGroup({
$,
data: {
jobId: this.jobId,
invoiceGroupId: this.invoiceGroupId,
},
});
$.export("$summary", `Successfully assigned contract job ${this.jobId} to invoice group ${this.invoiceGroupId}`);
return response;
},
};
Loading