Class: Flydata::Command::Sync

Inherits:
Base
  • Object
show all
Includes:
Helpers
Defined in:
lib/flydata/command/sync.rb

Direct Known Subclasses

Mysql, Mysqlbinlog, Mysqldump

Constant Summary collapse

RUN_PROFILE = 
false
INSERT_PROGRESS_INTERVAL = 
1000
SERVER_DATA_PROCESSING_TIMEOUT =

seconds

3600
STATUS_PARSING =

for dump.pos file

'PARSING'
STATUS_PARSED =

the value is different from the constant name on purpose for backward compatibility.

'WAITING'
STATUS_COMPLETE = 
'COMPLETE'

Constants included from Helpers

Helpers::UNIT_PREFIX

Instance Attribute Summary collapse

Attributes inherited from Base

#opts

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Helpers

as_size, development?, env_mode, env_suffix, flydata_api_host_file, flydata_conf_file, flydata_version, format_menu_list, retry_on, to_command_class, usage_text

Methods inherited from Base

#ask_input_table_name, #ask_yes_no, #choose_one, #dashboard_url, #flydata, #initialize, #newline, #redshift_console_url, #register_crontab, #retrieve_data_entries, #separator, #show_purpose_name, #source

Methods included from ExclusiveRunnable

included

Methods included from Flydata::CommandLoggable

#before_logging, #log_error_stderr, #log_info_stdout, #log_warn_stderr

Constructor Details

This class inherits a constructor from Flydata::Command::Base

Instance Attribute Details

#ddl_tables ⇒ Object (readonly)

true if full initial sync



41
42
43
 
# File 'lib/flydata/command/sync.rb', line 41

def ddl_tables
  @ddl_tables
end

#full_initial_sync ⇒ Object (readonly)

true if full initial sync



41
42
43
 
# File 'lib/flydata/command/sync.rb', line 41

def full_initial_sync
  @full_initial_sync
end

#full_tables ⇒ Object (readonly)

true if full initial sync



41
42
43
 
# File 'lib/flydata/command/sync.rb', line 41

def full_tables
  @full_tables
end

#input_tables ⇒ Object (readonly)

true if full initial sync



41
42
43
 
# File 'lib/flydata/command/sync.rb', line 41

def input_tables
  @input_tables
end

#new_tables ⇒ Object (readonly)

true if full initial sync



41
42
43
 
# File 'lib/flydata/command/sync.rb', line 41

def new_tables
  @new_tables
end

Class Method Details

.slop ⇒ Object

Command: flydata sync

- Arguments



52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/flydata/command/sync.rb', line 52

def self.slop
  Slop.new do
    on 'c', 'skip-cleanup', 'Skip server cleanup'
    on 'f', 'skip-flush', 'Skip server flush'
    on 'y', 'yes', 'Skip command prompt assuming yes to all questions.  Use this for batch operation.'
    on 'd', 'dump-file', 'Save dump result into a file.'
    on 's', 'dump-stream', 'Stream dump result to a pipe instead of saving dump file. It might cause timeout error if db size is larger than 10GB.'
    on 'n', 'no-flydata-start', 'Don\'t start the flydata agent after initial sync.'
    #TODO : This option is temp! Should remove soon.
    on 'ff', 'Skip checking query queue and flush'
  end
end

.slop_flush ⇒ Object

Command: flydata sync:flush

- Arguments



82
83
84
85
86
87
88
 
# File 'lib/flydata/command/sync.rb', line 82

def self.slop_flush
  Slop.new do
    on 'f', 'skip-flush', 'Skip server flush'
    on 'y', 'yes', 'Skip command prompt assuming yes to all questions.  Use this for batch operation.'
    on 'force-run', 'Run forcefully, ignoring exclusive run info'
  end
end

.slop_generate_table_ddl ⇒ Object

Command: flydata sync:generate_table_ddl

- Arguments



237
238
239
240
241
242
243
244
245
 
# File 'lib/flydata/command/sync.rb', line 237

def self.slop_generate_table_ddl
  Slop.new do
    on 'c', 'ctl-only', 'Only generate FlyData Control definitions'
    on 'y', 'yes', 'Skip command prompt assuming yes to all questions.  Use this for batch operation.'
    on 's', 'skip-primary-key-check', 'Skip primary key check when generating DDL'
    on 'all-tables', 'Generate all table schema'
    #no 'force-run' option. because stdout is often redirected to a file.
  end
end

.slop_repair ⇒ Object

Command: flydata sync:repair

- Arguments



264
265
266
267
268
269
 
# File 'lib/flydata/command/sync.rb', line 264

def self.slop_repair
  Slop.new do
    on 'y', 'yes', 'Skip command prompt assuming yes to all questions.  Use this for batch operation.'
    on 'force-run', 'Run forcefully, ignoring exclusive run info'
  end
end

.slop_reset ⇒ Object

Command: flydata sync:reset

- Arguments



110
111
112
113
114
115
116
117
118
119
 
# File 'lib/flydata/command/sync.rb', line 110

def self.slop_reset
  Slop.new do
    on 'c', 'client', 'Resets client only.'
    on 'y', 'yes', 'Skip command prompt assuming yes to all questions.  Use this for batch operation.'
    on 'a', 'all', 'Resets Sync for all tables'
    on 'i', 'init', 'Resets unfinished initial sync'
    on 'force-run', 'Run forcefully, ignoring exclusive run info'
    on 'f', 'force', "Resets tables including append only tables.  Use this option only when you want to stop sync for the append only table permanently."
  end
end

Instance Method Details

#check(options = {}) ⇒ Object

Command: flydata sync:check

- Entry method



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/flydata/command/sync.rb', line 280

def check(options = {})
  context = source.source_pos
  status, pos_mismatch_tables, gap_tables = _check(context, options)

  if status.include? :OK
    message = "\nNo errors are found.  Sync is clean.\n"
  else
    message = "\nFollowing errors are found.\n"

    if status.include? :STUCK_AT_PROCESS
      message += " - Data is stuck while processing\n"
    end
    if status.include? :STUCK_AT_UPLOAD
      message += " - Data is stuck while uploading\n"
    end
    if status.include? :ABNORMAL_SHUTDOWN
      message += " - Agent was not shut down correctly\n"
    end
    if gap_tables
      message += " - Sync data is missing for the following table(s)\n"
      gap_tables.each do |bt|
        message += "     table:#{bt[:table]}\n"
      end
      message += "\n"
    end
    if pos_mismatch_tables
      message += " - Incorrect table position(s)\n"
      pos_mismatch_tables.each do |bt|
        message += "     table:#{bt[:table]}, agent position:#{bt[:agent_seq] ? bt[:agent_seq] : '(missing)'}, server position:#{bt[:server_seq]}\n"
      end
      message += "\n"
    end
  end
  log_info_stdout message
end

#compat_check ⇒ Object

Command: flydata sync:compat_check

- Entry method



319
320
321
322
 
# File 'lib/flydata/command/sync.rb', line 319

def compat_check
  context = source.sync_generate_table_ddl(flydata.data_port.get, opts)
  context.run_compatibility_check
end

#flush(*tables) ⇒ Object

Command: flydata sync:flush

- Entry method



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/flydata/command/sync.rb', line 92

def flush(*tables)
  begin
    flush_buffer_and_stop(tables, skip_flush: opts.skip_flush?)
  rescue ServerDataProcessingTimeout => e
    ee = ServerDataProcessingTimeout.new("Delayed Data Processing")
    ee.description = "  Data processing is taking more than expected.  Please contact [email protected] to check the system status.\n\n"
    ee.set_backtrace e.backtrace
    raise ee
  end
  log_info_stdout("Buffers have been flushed and the sender process has been stopped.")
end

#generate_table_ddl(*tables) ⇒ Object

Command: flydata sync:generate_table_ddl

- Entry method



249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/flydata/command/sync.rb', line 249

def generate_table_ddl(*tables)
  # Compatibility check
  de = data_entry
  context = source.sync_generate_table_ddl(flydata.data_port.get, opts)
  context.run_compatibility_check

  # Set instance variables
  set_current_tables(tables, include_all_tables: true)

  do_generate_table_ddl(context, de)
end

#repair ⇒ Object

Command: flydata sync:repair

- Entry method



273
274
275
 
# File 'lib/flydata/command/sync.rb', line 273

def repair
  _repair
end

#reset(*tables) ⇒ Object

Command: flydata sync:reset

- Entry method



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
 
# File 'lib/flydata/command/sync.rb', line 123

def reset(*tables)

  if tables.empty? && !opts[:all] && !opts[:init]
    log_info_stdout "ERROR!  Argument or option must be specified.\n\n  To reset all tables:              flydata sync:reset --all\n  To reset specific tables:         flydata sync:reset table1 table2 ...\n  To reset unfinished initial sync: flydata sync:reset --init\n"
    return
  end

  # Set instance variables
  reset_init = opts[:init]
  if opts[:all]
    tables = []
    reset_init = false
  end
  sync_resumed = set_current_tables(tables, resume: !opts[:all])
  target_tables = opts[:all] ? @full_tables : @input_tables
  target_append_only_tables = target_tables & @append_only_tables
  target_full_sync_tables = target_tables - @append_only_tables

  return if !sync_resumed && reset_init

  message = ''
  if sync_resumed && !tables.empty?
    log_info_stdout "ERROR!  You cannot reset tables because the previous initial sync has not been completed.  Reset the unfinished initial sync first with the following command:\n\n  flydata sync:reset --init\n\n"
    return
  end

  if target_append_only_tables.size > 0 && !opts[:force]
    log_info_stdout "ERROR!  Reset failed because it includes append only table(s).  Sync can no longer continue if you reset an append only table.\n\n  Append only table(s): \#{target_append_only_tables.join(\", \")}\n\nIf you really want to reset append-only tables, use '--force' option.\n\n"

    log_info_stdout "To reset all tables except for append only tables, run the following command.\n\n  flydata sync:reset \#{target_full_sync_tables.join(\" \")}\n\n" unless target_full_sync_tables.empty?
    return
  end

  # Flush client buffer
  msg_tables = @input_tables.empty? ? '' : " for these tables : #{@input_tables.join(" ")}"
  msg_sync_type = sync_resumed ? "the current initial sync" : "the current sync"
  show_purpose_name
  return unless ask_yes_no("This resets #{msg_sync_type}#{msg_tables}.  Are you sure?")
  sender = Flydata::Command::Sender.new
  sender.flush_client_buffer # TODO We should rather delete buffer files
  sender.stop

  begin
    wait_for_server_buffer(timeout: SERVER_DATA_PROCESSING_TIMEOUT, tables: target_tables_for_api)
  rescue ServerDataProcessingTimeout => e
    ee = ServerDataProcessingTimeout.new("Delayed Data Processing")
    ee.description = "  Data processing is taking more than expected.  Please contact [email protected] to check the system status.\n  Once checked, you can continue sync reset with the following command\n\n    flydata sync:reset \#{tables.empty? ? '' : tables.join(\" \")}\n\n"
    ee.set_backtrace e.backtrace
    raise ee
  end

  # Cleanup tables on server
  de = data_entry
  cleanup_sync_server(de, @input_tables) unless opts.client?
  sync_fm = create_sync_file_manager(de)

  # Delete local files
  sync_fm.delete_dump_files
  sync_fm.delete_table_control_files(*@input_tables)

  new_tables_after_reset = @unsynced_tables + @input_tables
  if @input_tables.empty? or @full_tables.empty? or @full_tables.all?{|ft| new_tables_after_reset.include?(ft)}
    sync_fm.delete_master_position_files
  end
  sync_fm.close
  log_info_stdout("Reset completed successfully.")
end

#run(*tables) ⇒ Object

Command: flydata sync

- Entry method



67
68
69
 
# File 'lib/flydata/command/sync.rb', line 67

def run(*tables)
  raise "Command 'flydata sync' has been deprecated.  Use 'flydata start' instead."
end

#skip ⇒ Object

Depricated Command: flydata sync:skip skip initial sync



223
224
225
226
227
228
229
230
231
232
 
# File 'lib/flydata/command/sync.rb', line 223

def skip
  de = data_entry
  sync_fm = create_sync_file_manager(de)
  source_pos_path = sync_fm.source_pos_path
  sync_fm.close
  `touch #{source_pos_path}`
  log_info_stdout("Created an empty source position file.")
  log_info_stdout("-> #{source_pos_path}")
  log_info_stdout("Run 'flydata start' to start continuous sync.")
end

#try_initial_sync(options) ⇒ Object

Public method

- Called from Sender#start/restart



74
75
76
77
78
 
# File 'lib/flydata/command/sync.rb', line 74

def try_initial_sync(options)
  handle_initial_sync(nil, options) if source.sync.supported?
rescue Source::UnsupportedSourceError
  return
end