Class: Rafflesia::DatabaseJoinRequirements

Inherits:

Object

• Object
• Rafflesia::DatabaseJoinRequirements

Defined in:

lib/rafflesia/database_join_requirements.rb

Instance Method Summary

• #create(sources:, sql:, dialect: nil, join_evidence_policy: nil, ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeDatabaseJoinRequirementsData

  POST /v1/database_join_requirements.

• #initialize(client) ⇒ DatabaseJoinRequirements constructor

  A new instance of DatabaseJoinRequirements.

Constructor Details

#initialize(client) ⇒ DatabaseJoinRequirements

Returns a new instance of DatabaseJoinRequirements.

# File 'lib/rafflesia/database_join_requirements.rb', line 9

def initialize(client)
  @client = client
end

Instance Method Details

#create(sources:, sql:, dialect: nil, join_evidence_policy: nil, ontology_digest: nil, request_options: {}) ⇒ Rafflesia::EnvelopeDatabaseJoinRequirementsData

POST /v1/database_join_requirements

Parameters:

• dialect (String, nil) (defaults to: nil)
• join_evidence_policy (Rafflesia::Types::DatabaseJoinRequirementsRequestJoinEvidencePolicy, nil) (defaults to: nil) —

  Required retained evidence level; defaults to cardinality_consistent.

• ontology_digest (String, nil) (defaults to: nil)
• sources (Array<Rafflesia::QuerySource>, nil)
• sql (String)
• request_options (Hash) (defaults to: {}) —

  (see Rafflesia::Types::RequestOptions)

Returns:

• (Rafflesia::EnvelopeDatabaseJoinRequirementsData)

# File 'lib/rafflesia/database_join_requirements.rb', line 21

def create(
  sources:,
  sql:,
  dialect: nil,
  join_evidence_policy: nil,
  ontology_digest: nil,
  request_options: {}
)
  body = {
    'dialect' => dialect,
    'join_evidence_policy' => join_evidence_policy,
    'ontology_digest' => ontology_digest,
    'sources' => sources,
    'sql' => sql
  }.compact
  response = @client.request(
    method: :post,
    path: '/v1/database_join_requirements',
    auth: true,
    body: body,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeDatabaseJoinRequirementsData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end