upgrade_private_sqls

Creates, updates, deletes, gets or lists a upgrade_private_sqls resource.

Overview

Name	upgrade_private_sqls
Type	Resource
Id	ovh.order.upgrade_private_sqls

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
operation	object	Upgrade operation
order	object	Order placed

list_by_domain

Representation of a generic product

Name	Datatype	Description
product_name	string	Name of the product (wire: productName)
plan_code	string	Product offer identifier (wire: planCode)
prices	array	Prices of the product offer
product_type	string	Product type (cloud_service, delivery, deposit, domain, implementation_services, saas_license, shipping, storage) (wire: productType)

list

Name	Datatype	Description
value	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain, plan_code, quantity		Get a provisional order for the selected upgrade of your service (Beta version)
list_by_domain	select	domain		Retrieve available offers to upgrade your service to (Beta version)
list	select			List available services (Beta version)
create	insert	domain, plan_code, quantity		Perform the requested upgrade of your service (Beta version)

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
domain	string	The internal ID of your private SQL service
plan_code	string	Plan code of the offer you want to upgrade to (wire: planCode)
quantity	integer	Quantity you want to upgrade to

SELECT examples

get

Get a provisional order for the selected upgrade of your service (Beta version)

SELECT
operation,
order
FROM ovh.order.upgrade_private_sqls
WHERE domain = '{{ domain }}' -- required
AND plan_code = '{{ plan_code }}' -- required
AND quantity = '{{ quantity }}' -- required
;

list_by_domain

Retrieve available offers to upgrade your service to (Beta version)

SELECT
product_name,
plan_code,
prices,
product_type
FROM ovh.order.upgrade_private_sqls
WHERE domain = '{{ domain }}' -- required
;

list

List available services (Beta version)

SELECT
value
FROM ovh.order.upgrade_private_sqls
;

INSERT examples

create

Perform the requested upgrade of your service (Beta version)

INSERT INTO ovh.order.upgrade_private_sqls (
auto_pay_with_preferred_payment_method,
quantity,
domain,
plan_code
)
SELECT 
{{ auto_pay_with_preferred_payment_method }},
{{ quantity }} /* required */,
'{{ domain }}',
'{{ plan_code }}'
RETURNING
operation,
order
;

Manifest

# Description fields are for documentation purposes
- name: upgrade_private_sqls
props:
  - name: domain
    value: "{{ domain }}"
    description: Required parameter for the upgrade_private_sqls resource.
  - name: plan_code
    value: "{{ plan_code }}"
    description: Required parameter for the upgrade_private_sqls resource.
  - name: auto_pay_with_preferred_payment_method
    value: {{ auto_pay_with_preferred_payment_method }}
    description: |
      Indicates that order will be automatically paid with preferred payment method
  - name: quantity
    value: {{ quantity }}
    description: |
      Quantity you want to upgrade to