← FaunaDB

Read From FaunaDB Collection with FaunaDB API

Pipedream makes it easy to connect APIs for FaunaDB and 900+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Read From FaunaDB Collection with the FaunaDB API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

Create a workflow to Read From FaunaDB Collection with the FaunaDB API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Read From FaunaDB Collection action
    1. Connect your FaunaDB account
    2. Select a Collection
    3. Optional- Configure Document Field
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Read From FaunaDB Collection with FaunaDB API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + FaunaDB
 
Try it
Read From FaunaDB Collection with FaunaDB API on New Item in Feed from RSS API
RSS + FaunaDB
 
Try it
Read From FaunaDB Collection with FaunaDB API on New Message from Discord API
Discord + FaunaDB
 
Try it
Read From FaunaDB Collection with FaunaDB API on New Message In Channels from Slack API
Slack + FaunaDB
 
Try it
Read From FaunaDB Collection with FaunaDB API on New Message in Channel from Discord Bot API
Discord Bot + FaunaDB
 
Try it

Details

This is a pre-built, open source component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Read From FaunaDB Collection on FaunaDB
Description:Reads all documents from a given FaunaDB collection. [See docs here](https://docs.fauna.com/fauna/current/api/fql/functions/documents)
Version:0.4.3
Key:faunadb-read-from-collection

Code

import faunadb from "../../faunadb.app.mjs";

export default {
  key: "faunadb-read-from-collection",
  name: "Read From FaunaDB Collection",
  description: "Reads all documents from a given FaunaDB collection. [See docs here](https://docs.fauna.com/fauna/current/api/fql/functions/documents)",
  version: "0.4.3",
  type: "action",
  props: {
    faunadb,
    collectionName: {
      propDefinition: [
        faunadb,
        "collections",
      ],
    },
    documentField: {
      label: "Document Field",
      description: "The value of the document field that will be returned by query",
      type: "string",
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      collectionName,
      documentField,
    } = this;

    const response = await this.faunadb.getDocumentsInCollection({
      collectionName,
      documentField,
    });

    $.export("$summary", "Successfully retrieved the collection's documents");

    return response;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
FaunaDBfaunadbappThis component uses the FaunaDB app.
CollectioncollectionNamestringSelect a value from the drop down menu.
Document FielddocumentFieldstring

The value of the document field that will be returned by query

Authentication

FaunaDB uses API keys for authentication. When you connect your FaunaDB account, Pipedream securely stores the keys so you can easily authenticate to FaunaDB APIs in both code and no-code steps.

Create a key in the Security section of your FaunaDB dashboard, then enter the Secret below.

Read more about Keys and Fauna Security.

About FaunaDB

The database built for serverless, featuring native GraphQL

More Ways to Use FaunaDB

Triggers

New or Removed Documents in a Collection from the FaunaDB API

Emit new event each time you add or remove a document from a specific collection, with the details of the document.

 
Try it

Actions

Execute GraphQL Query with the FaunaDB API

Performs an arbitrary authorized GraphQL query. See docs here

 
Try it
Import GraphQL schema with the FaunaDB API

Import graphQL schema to a database. See docs here

 
Try it