@openfn/language-mysql 1.3.1 → 1.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -8,17 +8,12 @@ for the full list of available helper functions including `upsert(...)`.**
8
8
 
9
9
  ## Documentation
10
10
 
11
- ## sample configuration
12
-
13
- ```json
14
- {
15
- "host": "some-host-url.compute-1.amazonaws.com",
16
- "port": "3306",
17
- "database": "wouldntyouliketoknow",
18
- "user": "me",
19
- "password": "noway"
20
- }
21
- ```
11
+ ### Configuration
12
+
13
+ View all the required and optional properties for `state.configuration` in the
14
+ official
15
+ [configuration-schema](https://docs.openfn.org/adaptors/packages/mysql-configuration-schema/)
16
+ definition.
22
17
 
23
18
  ## Execute a query
24
19
 
@@ -6,33 +6,48 @@
6
6
  "type": "string",
7
7
  "description": "The database instance host URL",
8
8
  "format": "uri",
9
- "minLength": 1
9
+ "minLength": 1,
10
+ "examples": [
11
+ "some-host-url.compute-1.amazonaws.com"
12
+ ]
10
13
  },
11
14
  "port": {
12
15
  "title": "Port",
13
16
  "type": "integer",
14
17
  "default": 3306,
15
18
  "description": "Database instance port",
16
- "minLength": 1
19
+ "minLength": 1,
20
+ "examples": [
21
+ 3306
22
+ ]
17
23
  },
18
24
  "database": {
19
25
  "title": "Database",
20
26
  "type": "string",
21
27
  "description": "The database name",
22
- "minLength": 1
28
+ "minLength": 1,
29
+ "examples": [
30
+ "demo-db"
31
+ ]
23
32
  },
24
33
  "user": {
25
34
  "title": "Username",
26
35
  "type": "string",
27
36
  "description": "The username to log in the database",
28
- "minLength": 1
37
+ "minLength": 1,
38
+ "examples": [
39
+ "admin-demo"
40
+ ]
29
41
  },
30
42
  "password": {
31
43
  "title": "Password",
32
44
  "type": "string",
33
45
  "description": "The password to log in the database",
34
46
  "writeOnly": true,
35
- "minLength": 1
47
+ "minLength": 1,
48
+ "examples": [
49
+ "@super(!)Secretpass"
50
+ ]
36
51
  }
37
52
  },
38
53
  "type": "object",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfn/language-mysql",
3
- "version": "1.3.1",
3
+ "version": "1.3.3",
4
4
  "description": "A MySQL Language Pack for OpenFn",
5
5
  "homepage": "https://docs.openfn.org",
6
6
  "main": "dist/index.cjs",