Skip to content

Overview

Pour le moment, le SDK des ressources Dataflow n'est accessible que depuis les ressources Fonction.

Ce SDK permet l'usage des différentes fonctions associées aux dataflow, incluant la lecture / écriture de documents sur un dataflow, mais aussi la lecture et écriture de vues.

Usage

Initialisation

Pour initialiser le SDK, deux informations sont nécessaires :
- Id du dataflow : celui-ci peut être récupéré dans la barre d'adresse du navigateur sur l'écran du dataflow
- Access Token : token d'authentification

const accessToken = "..."
const dataflowId = "..."
const dataflow = new Dataflow(accessToken, dataflowId)

Méthodes

Lister les documents

// All documents  
result = await dataflow.documents()  

// with a query  
result = await dataflow.documents({ "where": { "city": "Toulouse" } })

// first page only
result = await dataflow.documents({ "page": 1, "perPage": 10 })

Lister les vues

// All views
result = await dataflow.views()  

Lister les documents d'une vue

// All documents  
result = await dataflow.viewDocuments('viewName')  

// first page only
result = await dataflow.viewDocuments('viewName', { "page": 1, "perPage": 10 })

Créer un document

result = await dataflow.create({ name: 'Martin', 'city': 'Toulouse' })

Modifier un document

result = await dataflow.update('docId', { name: 'Martin', 'city': 'Tolosa' })

Créer / Modifier une vue

result = await dataflow.updateView('viewName', {
  "query": {
    "city": "Toulouse",
  },
  "columns": ["city"]
})

Plus d'informations sur les vues

Supprimer un document

result = await dataflow.delete('docId')