diff --git a/README.md b/README.md index b485f96..ca6bc7d 100644 --- a/README.md +++ b/README.md @@ -94,3 +94,90 @@ PLUGINS=mongodb \ http \ someplugin ``` + +# Plugin parameters + +Di seguito sono elencati i parametri che รจ possibile passare ai plugin da `jr` da linea di comando con: `-p .=` + +### AWS DynamoDB Plugin + +| Parameter Name | Type | Example | Description | +|----------------|--------|-------------------------------|--------------------------------------| +| table | string | `-p .table=myTable` | The name of the DynamoDB table to use. | + +### Azure Blob Storage Plugin + +| Parameter Name | Type | Example | Description | +|---------------------|--------|----------------------------------------------|--------------------------------------------------| +| container.name | string | `-p .container.name=myContainer` | The name of the Azure Blob Storage container. | +| metadata. | string | `-p .metadata.key=value` | Metadata to be added to the blob. | + +### Azure Cosmos DB Plugin + +| Parameter Name | Type | Example | Description | +|---------------------|--------|----------------------------------------------|--------------------------------------------------| +| partition_key | string | `-p .partition_key=myPartition` | The value of the partition key for the item. | +| database | string | `-p .database=myDatabase` | The name of the database to use. | +| container | string | `-p .container=myContainer` | The name of the container to use. | + +### Cassandra Plugin + +| Parameter Name | Type | Example | Description | +|---------------------|--------|----------------------------------------------|--------------------------------------------------| +| keyspace | string | `-p .keyspace=myKeyspace` | The keyspace to use for the Cassandra database. | +| table | string | `-p .table=myTable` | The table to insert data into. | +| consistency_level | string | `-p .consistency_level=QUORUM` | The consistency level for the operation. | + +### GCS Plugin + +| Parameter Name | Type | Example | Description | +|---------------------|--------|----------------------------------------------|--------------------------------------------------| +| bucket | string | `-p .bucket=myBucket` | The name of the Google Cloud Storage bucket. | + +### HTTP Plugin + +| Parameter Name | Type | Example | Description | +|-----------------------------|--------|----------------------------------------------|--------------------------------------------------| +| endpoint.url | string | `-p .endpoint.url=http://example.com` | The URL of the endpoint to send the request to. | +| endpoint.method | string | `-p .endpoint.method=POST` | The HTTP method to use (e.g., POST, PUT). | +| endpoint.timeout | int | `-p .endpoint.timeout=10s` | The timeout duration for the request. | +| error_handling.expect_status_code | int | `-p .error_handling.expect_status_code=200` | Expected status code | +| error_handling.ignore_status_code | int | `-p .error_handling.ignore_status_code=404` | Ignore status code | +| tls.insecure_skip_verify | bool | `-p .tls.insecure_skip_verify=true` | Whether to skip TLS verification. | + +### Lua Script Plugin + +| Parameter Name | Type | Example | Description | +|----------------|------|---------|-------------| +| N/A | N/A | N/A | No specific parameters are passed in configParams. | + +### MongoDB Plugin + +| Parameter Name | Type | Example | Description | +|----------------|--------|----------------------------------------------|--------------------------------------------------| +| database | string | `-p .database=myDatabase` | The name of the database to use. | +| collection | string | `-p .collection=myCollection` | The name of the collection to insert data into. | + +### Redis Plugin + +| Parameter Name | Type | Example | Description | +|----------------|--------|----------------------------------------------|--------------------------------------------------| +| ttl | int | `-p .ttl=60s` | The time-to-live for the key in seconds. | + +### S3 Plugin + +| Parameter Name | Type | Example | Description | +|----------------|--------|----------------------------------------------|--------------------------------------------------| +| bucket | string | `-p .bucket=myBucket` | The name of the S3 bucket to use. | + +### WASM Plugin + +| Parameter Name | Type | Example | Description | +|----------------|------|---------|-------------| +| N/A | N/A | N/A | No specific parameters are passed in configParams. | + +### Elastic Plugin + +| Parameter Name | Type | Example | Description | +|----------------|------|---------|-------------| +| N/A | N/A | N/A | No specific parameters are passed in configParams. |