Class: AvroTurf::ConfluentSchemaRegistry

Inherits:
Object
  • Object
show all
Defined in:
lib/avro_turf/confluent_schema_registry.rb

Constant Summary collapse

CONTENT_TYPE = 
"application/vnd.schemaregistry.v1+json".freeze

Instance Method Summary collapse

Constructor Details

#initialize(url, logger: Logger.new($stdout)) ⇒ ConfluentSchemaRegistry

Returns a new instance of ConfluentSchemaRegistry.



6
7
8
9
10
11
 
# File 'lib/avro_turf/confluent_schema_registry.rb', line 6

def initialize(url, logger: Logger.new($stdout))
  @logger = logger
  @connection = Excon.new(url, headers: {
    "Content-Type" => CONTENT_TYPE,
  })
end

Instance Method Details

#check(subject, schema) ⇒ Object

Check if a schema exists. Returns nil if not found.



47
48
49
50
51
52
 
# File 'lib/avro_turf/confluent_schema_registry.rb', line 47

def check(subject, schema)
  data = post("/subjects/#{subject}",
              expects: [200, 404],
              body: { schema: schema.to_s }.to_json)
  data unless data.has_key?("error_code")
end

#compatible?(subject, schema, version = 'latest') ⇒ Boolean

Check if a schema is compatible with the stored version. Returns:

  • true if compatible

  • nil if the subject or version does not exist

  • false if incompatible

docs.confluent.io/3.1.2/schema-registry/docs/api.html#compatibility

Returns:

  • (Boolean) 


60
61
62
63
64
65
 
# File 'lib/avro_turf/confluent_schema_registry.rb', line 60

def compatible?(subject, schema, version = 'latest')
  data = post("/compatibility/subjects/#{subject}/versions/#{version}",
              expects: [200, 404],
              body: { schema: schema.to_s }.to_json)
  data.fetch('is_compatible', false) unless data.has_key?('error_code')
end

#fetch(id) ⇒ Object 



13
14
15
16
17
 
# File 'lib/avro_turf/confluent_schema_registry.rb', line 13

def fetch(id)
  @logger.info "Fetching schema with id #{id}"
  data = get("/schemas/ids/#{id}")
  data.fetch("schema")
end

#global_config ⇒ Object

Get global config



68
69
70
 
# File 'lib/avro_turf/confluent_schema_registry.rb', line 68

def global_config
  get("/config")
end

#register(subject, schema) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/avro_turf/confluent_schema_registry.rb', line 19

def register(subject, schema)
  data = post("/subjects/#{subject}/versions", body: {
    schema: schema.to_s
  }.to_json)

  id = data.fetch("id")

  @logger.info "Registered schema for subject `#{subject}`; id = #{id}"

  id
end

#subject_config(subject) ⇒ Object

Get config for subject



78
79
80
 
# File 'lib/avro_turf/confluent_schema_registry.rb', line 78

def subject_config(subject)
  get("/config/#{subject}")
end

#subject_version(subject, version = 'latest') ⇒ Object

Get a specific version for a subject



42
43
44
 
# File 'lib/avro_turf/confluent_schema_registry.rb', line 42

def subject_version(subject, version = 'latest')
  get("/subjects/#{subject}/versions/#{version}")
end

#subject_versions(subject) ⇒ Object

List all versions for a subject



37
38
39
 
# File 'lib/avro_turf/confluent_schema_registry.rb', line 37

def subject_versions(subject)
  get("/subjects/#{subject}/versions")
end

#subjects ⇒ Object

List all subjects



32
33
34
 
# File 'lib/avro_turf/confluent_schema_registry.rb', line 32

def subjects
  get('/subjects')
end

#update_global_config(config) ⇒ Object

Update global config



73
74
75
 
# File 'lib/avro_turf/confluent_schema_registry.rb', line 73

def update_global_config(config)
  put("/config", { body: config.to_json })
end

#update_subject_config(subject, config) ⇒ Object

Update config for subject



83
84
85
 
# File 'lib/avro_turf/confluent_schema_registry.rb', line 83

def update_subject_config(subject, config)
  put("/config/#{subject}", { body: config.to_json })
end