❓ Other Connector Types

Though the SQL Connector is the premier Meerschaum connector type, there are plenty of other implementations of the instance connector interface.

🗝️ Valkey Connectors

Syncs pipes to a Valkey instance. Because Valkey is a fork of Redis, you may also use the ValkeyConnector to connect to your Redis instance.

Similar to sql:main, the built-in connector valkey:main connects to the Valkey instance in the Meerschaum stack.

• Implementation: built-in (docs)
• Type: valkey

Connector config

username: default
password: mrsm
host: localhost
port: 6379
db: 0
socket_timeout: 300

uri: valkey://default:mrsm@localhost:6379/0?timeout=300s 

🌐 API Connector

Syncs to a Meerschaum instance via the Web API. The pipes made available via the Web UI are from the instance set under MRSM{api_instance}, usually sql:main.

• Implementation: built-in (docs)
• Type: api

Connector config

protocol: http
username: foo
password: bar
host: localhost
port: 8000

uri: http://foo:bar@localhost:8000

🍃 MongoDB Connector

Syncs to a MongoDB cluster. Allows you to read from existing collections as well as storing your pipes' data in collections.

• Implementation: mongodb-connector plugin
• Type: mongodb

Connector config

uri: mongodb://localhost:27017 
database: foo

Fetch pipe

connector: mongodb:foo
metric: bar
parameters:
  fetch:
    query:
      a: 1
    projection: {}
    collection: bar

🛜 MQTT Connector

Subscribe to MQTT topics and sync the fetched messages.

• Implementation: mqtt-connector plugin
• Type: mqtt

Connector config

host: localhost
port: 1883
username: foo
password: bar
transport: tcp
keepalive: 60

Fetch pipe

connector: "mqtt:local"
metric: "temperature"
columns:
  datetime: "timestamp"
  topic: "topic"
parameters:
  fetch:
    topic:
    - "foo/#"
    - "bar/#"