Class: Retab::Tables

Inherits:
Object
  • Object
show all
Defined in:
lib/retab/tables.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Tables

Returns a new instance of Tables.



9
10
11
 
# File 'lib/retab/tables.rb', line 9

def initialize(client)
  @client = client
end

Instance Method Details

#create(name:, file:, column_schema_overrides: nil, request_options: {}) ⇒ Retab::WorkflowTableListResponse

Create Table

Parameters:

  • name (String)
  • file (String)
  • column_schema_overrides (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)

Returns:



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
 
# File 'lib/retab/tables.rb', line 38

def create(
  name:,
  file:,
  column_schema_overrides: nil,
  request_options: {}
)
  body = {
    "name" => name,
    "file" => file,
    "column_schema_overrides" => column_schema_overrides
  }.compact
  response = @client.request(
    method: :post,
    path: "/v1/tables",
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Retab::WorkflowTableListResponse.new(response.body)
  result.last_response = Retab::Types::ApiResponse.new(
    http_status: response.code.to_i,
    http_headers: response.each_header.to_h,
    request_id: response["x-request-id"]
  )
  result
end

#delete(table_id:, request_options: {}) ⇒ Retab::WorkflowTableListResponse

Delete Table

Parameters:

  • table_id (String)
  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)

Returns:



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/retab/tables.rb', line 156

def delete(
  table_id:,
  request_options: {}
)
  response = @client.request(
    method: :delete,
    path: "/v1/tables/#{Retab::Util.encode_path(table_id)}",
    auth: true,
    request_options: request_options
  )
  result = Retab::WorkflowTableListResponse.new(response.body)
  result.last_response = Retab::Types::ApiResponse.new(
    http_status: response.code.to_i,
    http_headers: response.each_header.to_h,
    request_id: response["x-request-id"]
  )
  result
end

#download(table_id:, request_options: {}) ⇒ void

This method returns an undefined value.

Download Table Csv

Parameters:

  • table_id (String)
  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)



179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/retab/tables.rb', line 179

def download(
  table_id:,
  request_options: {}
)
  @client.request(
    method: :get,
    path: "/v1/tables/#{Retab::Util.encode_path(table_id)}/download",
    auth: true,
    request_options: request_options
  )
  nil
end

#get(table_id:, request_options: {}) ⇒ Retab::WorkflowTableResponse

Get Table

Parameters:

  • table_id (String)
  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)

Returns:



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/retab/tables.rb', line 69

def get(
  table_id:,
  request_options: {}
)
  response = @client.request(
    method: :get,
    path: "/v1/tables/#{Retab::Util.encode_path(table_id)}",
    auth: true,
    request_options: request_options
  )
  result = Retab::WorkflowTableResponse.new(response.body)
  result.last_response = Retab::Types::ApiResponse.new(
    http_status: response.code.to_i,
    http_headers: response.each_header.to_h,
    request_id: response["x-request-id"]
  )
  result
end

#list(request_options: {}) ⇒ Retab::WorkflowTableListResponse

List Tables

Parameters:

  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)

Returns:



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/retab/tables.rb', line 16

def list(request_options: {})
  response = @client.request(
    method: :get,
    path: "/v1/tables",
    auth: true,
    request_options: request_options
  )
  result = Retab::WorkflowTableListResponse.new(response.body)
  result.last_response = Retab::Types::ApiResponse.new(
    http_status: response.code.to_i,
    http_headers: response.each_header.to_h,
    request_id: response["x-request-id"]
  )
  result
end

#profile(table_id:, select: nil, request_options: {}) ⇒ Retab::WorkflowTableProfileResponse

Profile Table

Parameters:

  • table_id (String)
  • select (Array<String>, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)

Returns:



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/retab/tables.rb', line 197

def profile(
  table_id:,
  select: nil,
  request_options: {}
)
  params = {
    "select" => select
  }.compact
  response = @client.request(
    method: :get,
    path: "/v1/tables/#{Retab::Util.encode_path(table_id)}/profile",
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Retab::WorkflowTableProfileResponse.new(response.body)
  result.last_response = Retab::Types::ApiResponse.new(
    http_status: response.code.to_i,
    http_headers: response.each_header.to_h,
    request_id: response["x-request-id"]
  )
  result
end

#query(table_id:, filters: nil, search: nil, case_sensitive: nil, select: nil, distinct: nil, group_by: nil, aggregations: nil, sort: nil, sample: nil, tail: nil, count_only: nil, include_explain: nil, sort_column: nil, sort_direction: nil, viewer_mode: nil, offset: nil, limit: nil, request_options: {}) ⇒ Retab::WorkflowTableRowsResponse

Query Table

Parameters:

Returns:



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/retab/tables.rb', line 242

def query(
  table_id:,
  filters: nil,
  search: nil,
  case_sensitive: nil,
  select: nil,
  distinct: nil,
  group_by: nil,
  aggregations: nil,
  sort: nil,
  sample: nil,
  tail: nil,
  count_only: nil,
  include_explain: nil,
  sort_column: nil,
  sort_direction: nil,
  viewer_mode: nil,
  offset: nil,
  limit: nil,
  request_options: {}
)
  body = {
    "filters" => filters,
    "search" => search,
    "case_sensitive" => case_sensitive,
    "select" => select,
    "distinct" => distinct,
    "group_by" => group_by,
    "aggregations" => aggregations,
    "sort" => sort,
    "sample" => sample,
    "tail" => tail,
    "count_only" => count_only,
    "include_explain" => include_explain,
    "sort_column" => sort_column,
    "sort_direction" => sort_direction,
    "viewer_mode" => viewer_mode,
    "offset" => offset,
    "limit" => limit
  }.compact
  response = @client.request(
    method: :post,
    path: "/v1/tables/#{Retab::Util.encode_path(table_id)}/query",
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Retab::WorkflowTableRowsResponse.new(response.body)
  result.last_response = Retab::Types::ApiResponse.new(
    http_status: response.code.to_i,
    http_headers: response.each_header.to_h,
    request_id: response["x-request-id"]
  )
  result
end

#replace(table_id:, file:, column_schema_overrides: nil, request_options: {}) ⇒ Retab::WorkflowTableListResponse

Replace Table

Parameters:

  • table_id (String)
  • file (String)
  • column_schema_overrides (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)

Returns:



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
 
# File 'lib/retab/tables.rb', line 94

def replace(
  table_id:,
  file:,
  column_schema_overrides: nil,
  request_options: {}
)
  body = {
    "file" => file,
    "column_schema_overrides" => column_schema_overrides
  }.compact
  response = @client.request(
    method: :put,
    path: "/v1/tables/#{Retab::Util.encode_path(table_id)}",
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Retab::WorkflowTableListResponse.new(response.body)
  result.last_response = Retab::Types::ApiResponse.new(
    http_status: response.code.to_i,
    http_headers: response.each_header.to_h,
    request_id: response["x-request-id"]
  )
  result
end

#schema(table_id:, request_options: {}) ⇒ Retab::WorkflowTableSchemaResponse

Get Table Schema

Parameters:

  • table_id (String)
  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)

Returns:



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/retab/tables.rb', line 302

def schema(
  table_id:,
  request_options: {}
)
  response = @client.request(
    method: :get,
    path: "/v1/tables/#{Retab::Util.encode_path(table_id)}/schema",
    auth: true,
    request_options: request_options
  )
  result = Retab::WorkflowTableSchemaResponse.new(response.body)
  result.last_response = Retab::Types::ApiResponse.new(
    http_status: response.code.to_i,
    http_headers: response.each_header.to_h,
    request_id: response["x-request-id"]
  )
  result
end

#update_table(table_id:, name: nil, metadata: nil, request_options: {}) ⇒ Retab::WorkflowTableListResponse

Update Table

Parameters:

  • table_id (String)
  • name (String, nil) (defaults to: nil)
  • metadata (Hash{String => Object}, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)

Returns:



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
 
# File 'lib/retab/tables.rb', line 126

def update_table(
  table_id:,
  name: nil,
  metadata: nil,
  request_options: {}
)
  body = {
    "name" => name,
    "metadata" => metadata
  }.compact
  response = @client.request(
    method: :patch,
    path: "/v1/tables/#{Retab::Util.encode_path(table_id)}",
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Retab::WorkflowTableListResponse.new(response.body)
  result.last_response = Retab::Types::ApiResponse.new(
    http_status: response.code.to_i,
    http_headers: response.each_header.to_h,
    request_id: response["x-request-id"]
  )
  result
end

#validate(table_id:, required_columns: nil, columns: nil, unique: nil, request_options: {}) ⇒ Retab::WorkflowTableValidationResponse

Validate Table

Parameters:

  • table_id (String)
  • required_columns (Array<String>, nil) (defaults to: nil)
  • columns (Hash{String => Retab::WorkflowTableValidationColumnRule}, nil) (defaults to: nil)
  • unique (Array<Array<String>>, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Retab::Types::RequestOptions)

Returns:



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/retab/tables.rb', line 328

def validate(
  table_id:,
  required_columns: nil,
  columns: nil,
  unique: nil,
  request_options: {}
)
  body = {
    "required_columns" => required_columns,
    "columns" => columns,
    "unique" => unique
  }.compact
  response = @client.request(
    method: :post,
    path: "/v1/tables/#{Retab::Util.encode_path(table_id)}/validate",
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Retab::WorkflowTableValidationResponse.new(response.body)
  result.last_response = Retab::Types::ApiResponse.new(
    http_status: response.code.to_i,
    http_headers: response.each_header.to_h,
    request_id: response["x-request-id"]
  )
  result
end