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, project_id: nil, request_options: {}) ⇒ Retab::WorkflowTableListResponse

Table.Create

Parameters:

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

    (see Retab::Types::RequestOptions)

Returns:



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

def create(
  name:,
  file:,
  column_schema_overrides: nil,
  project_id: nil,
  request_options: {}
)
  multipart_fields = {}
  multipart_fields["name"] = name unless name.nil?
  multipart_fields["file"] = Retab::Multipart::FilePart.new(file, filename: "file") unless file.nil?
  multipart_fields["column_schema_overrides"] = column_schema_overrides unless column_schema_overrides.nil?
  multipart_fields["project_id"] = project_id unless project_id.nil?
  body = Retab::Multipart.new(multipart_fields)
  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: {}) ⇒ void

This method returns an undefined value.

Table.Delete

Parameters:

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

    (see Retab::Types::RequestOptions)



167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/retab/tables.rb', line 167

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

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

Table.Download

Parameters:

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

    (see Retab::Types::RequestOptions)

Returns:

  • (String) 


184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/retab/tables.rb', line 184

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

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

Table.Get

Parameters:

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

    (see Retab::Types::RequestOptions)

Returns:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/retab/tables.rb', line 80

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(project_id: nil, request_options: {}) ⇒ Retab::WorkflowTableListResponse

Table.List

Parameters:

  • project_id (String, nil) (defaults to: nil) —

    Only return tables belonging to this project.

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

    (see Retab::Types::RequestOptions)

Returns:



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/retab/tables.rb', line 17

def list(
  project_id: nil,
  request_options: {}
)
  params = {
    "project_id" => project_id
  }.compact
  response = @client.request(
    method: :get,
    path: "/v1/tables",
    auth: true,
    params: params,
    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

Table.Get Profile

Parameters:

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

    (see Retab::Types::RequestOptions)

Returns:



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/retab/tables.rb', line 202

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

Table.Query

Parameters:

Returns:



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
297
298
299
300
301
 
# File 'lib/retab/tables.rb', line 247

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

Table.Replace

Parameters:

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

    (see Retab::Types::RequestOptions)

Returns:



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

def replace(
  table_id:,
  file:,
  column_schema_overrides: nil,
  request_options: {}
)
  multipart_fields = {}
  multipart_fields["file"] = Retab::Multipart::FilePart.new(file, filename: "file") unless file.nil?
  multipart_fields["column_schema_overrides"] = column_schema_overrides unless column_schema_overrides.nil?
  body = Retab::Multipart.new(multipart_fields)
  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

Table.Get Schema

Parameters:

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

    (see Retab::Types::RequestOptions)

Returns:



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/retab/tables.rb', line 307

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

Table.Update

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:



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

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

Table.Validate

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:



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/retab/tables.rb', line 333

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