-
Notifications
You must be signed in to change notification settings - Fork 11
/
information_model.cljc
226 lines (183 loc) · 6.08 KB
/
information_model.cljc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
(ns onyx.sql.information-model)
(def model
{:catalog-entry
{:onyx.plugin.sql/partition-keys
{:summary "Partitions a table of rows into chunks to be read by another task. Requires a column in the table to be numerically ordered."
:model {:sql/classname
{:type :string
:doc "The JDBC classname driver to use."}
:sql/subprotocol
{:type :string
:doc "The database JDBC subprotocol."}
:sql/subname
{:type :string
:doc "The subname to connect to."}
:sql/user
{:type :string
:doc "The user to authenticate with."}
:sql/password
{:type :string
:doc "The password to authenticate with."}
:sql/db-name
{:type :string
:doc "The database to connect to."}
:sql/table
{:type :keyword
:doc "The table to read/write from/to."}
:sql/id
{:type :keyword
:doc "the name of a unique, monotonically increasing integer column."}
:sql/lower-bound
{:type :integer
:doc "Overrides calculation of min value from the id column."}
:sql/upper-bound
{:type :integer
:doc "Overrides calculation of max value from the id column."}
:sql/rows-per-segment
{:type :integer
:optional? true
:default 1000
:doc "The number of rows to compress into a single segment."}
:sql/read-buffer
{:type :integer
:optional? true
:default 1000
:doc "The number of messages to buffer via core.async, default is `1000`."}}}
:onyx.plugin.sql/read-rows
{:summary "Reads a partition of a rows from a SQL table."
:model {:sql/classname
{:type :string
:doc "The JDBC classname driver to use."}
:sql/subprotocol
{:type :string
:doc "The database JDBC subprotocol."}
:sql/subname
{:type :string
:doc "The subname to connect to."}
:sql/user
{:type :string
:optional? true
:doc "The user to authenticate with."}
:sql/password
{:type :string
:doc "The password to authenticate with."}
:sql/db-name
{:type :string
:optional? true
:doc "The database to connect to."}
:sql/table
{:type :keyword
:doc "The table to read/write from/to."}
:sql/id
{:type :keyword
:doc "The name of a unique, monotonically increasing integer column."}}}
:onyx.plugin.sql/write-rows
{:summary "Writes segments to a SQL database. Expects segments with the same schema as the table they are being inserted into. They must be batched together into a single segment."
:model {:sql/classname
{:type :string
:doc "The JDBC classname driver to use."}
:sql/subprotocol
{:type :string
:doc "The database JDBC subprotocol."}
:sql/subname
{:type :string
:doc "The subname to connect to."}
:sql/user
{:type :string
:optional? true
:doc "The user to authenticate with."}
:sql/password
{:type :string
:doc "The password to authenticate with."}
:sql/db-name
{:type :string
:optional? true
:doc "The database to connect to."}
:sql/table
{:type :keyword
:doc "The table to read/write from/to."}
:sql/copy?
{:type :boolean
:optional? true
:doc "Whether or not to use COPY for batch inserts. Note: currently only supported for PostgreSQL."}
:sql/copy-columns
{:type :vector
:optional? true
:doc "When copy? is true, describes the order in which the columns are sent to the db."}}}
:onyx.plugin.sql/upsert-rows
{:summary "Upserts segments to a SQL database."
:model {:sql/classname
{:type :string
:doc "The JDBC classname driver to use."}
:sql/subprotocol
{:type :string
:doc "The database JDBC subprotocol."}
:sql/subname
{:type :string
:doc "The subname to connect to."}
:sql/user
{:type :string
:doc "The user to authenticate with."}
:sql/password
{:type :string
:doc "The password to authenticate with."}
:sql/db-name
{:type :string
:doc "The database to connect to."}
:sql/table
{:type :keyword
:doc "The table to read/write from/to."}}}}
:lifecycles-entry
{:onyx.plugin.sql/partition-keys
{:model
[]}
:onyx.plugin.sql/read-rows
{:model
[]}
:onyx.plugin.sql/write-rows
{:model
[]}
:onyx.plugin.sql/upsert-rows
{:model
[]}}
:display-order
{:onyx.plugin.sql/partition-keys
[:sql/classname
:sql/subname
:sql/subprotocol
:sql/user
:sql/password
:sql/db-name
:sql/table
:sql/id
:sql/lower-bound
:sql/upper-bound
:sql/rows-per-segment
:sql/read-buffer]
:onyx.plugin.sql/read-rows
[:sql/classname
:sql/subname
:sql/subprotocol
:sql/user
:sql/password
:sql/db-name
:sql/table
:sql/id]
:onyx.plugin.sql/write-rows
[:sql/classname
:sql/subname
:sql/subprotocol
:sql/user
:sql/password
:sql/db-name
:sql/table
:sql/copy?
:sql/copy-columns]
:onyx.plugin.sql/upsert-rows
[:sql/classname
:sql/subname
:sql/subprotocol
:sql/user
:sql/password
:sql/db-name
:sql/table]}})