sites_snippets

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

Overview

Name	sites_snippets
Type	Resource
Id	netlify.snippet.sites_snippets

Fields

The following fields are returned by SELECT queries:

getSiteSnippet

Name	Datatype	Description
id	integer (int32)
site_id	string
general	string
general_position	string
goal	string
goal_position	string
title	string

listSiteSnippets

Name	Datatype	Description
id	integer (int32)
site_id	string
general	string
general_position	string
goal	string
goal_position	string
title	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
getSiteSnippet	select	site_id, snippet_id
listSiteSnippets	select	site_id
createSiteSnippet	insert	site_id
deleteSiteSnippet	delete	site_id, snippet_id
updateSiteSnippet	exec	site_id, snippet_id

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
site_id	string
snippet_id	string

SELECT examples

getSiteSnippet

OK

SELECT
id,
site_id,
general,
general_position,
goal,
goal_position,
title
FROM netlify.snippet.sites_snippets
WHERE site_id = '{{ site_id }}' -- required
AND snippet_id = '{{ snippet_id }}' -- required
;

listSiteSnippets

OK

SELECT
id,
site_id,
general,
general_position,
goal,
goal_position,
title
FROM netlify.snippet.sites_snippets
WHERE site_id = '{{ site_id }}' -- required
;

INSERT examples

createSiteSnippet

No description available.

INSERT INTO netlify.snippet.sites_snippets (
data__general,
data__general_position,
data__goal,
data__goal_position,
data__id,
data__site_id,
data__title,
site_id
)
SELECT 
'{{ general }}',
'{{ general_position }}',
'{{ goal }}',
'{{ goal_position }}',
{{ id }},
'{{ site_id }}',
'{{ title }}',
'{{ site_id }}'
RETURNING
id,
site_id,
general,
general_position,
goal,
goal_position,
title
;

Manifest

# Description fields are for documentation purposes
- name: sites_snippets
  props:
    - name: site_id
      value: string
      description: Required parameter for the sites_snippets resource.
    - name: general
      value: string
    - name: general_position
      value: string
    - name: goal
      value: string
    - name: goal_position
      value: string
    - name: id
      value: integer
    - name: site_id
      value: string
    - name: title
      value: string

DELETE examples

deleteSiteSnippet

No description available.

DELETE FROM netlify.snippet.sites_snippets
WHERE site_id = '{{ site_id }}' --required
AND snippet_id = '{{ snippet_id }}' --required
;

Lifecycle Methods

updateSiteSnippet

No content

EXEC netlify.snippet.sites_snippets.updateSiteSnippet 
@site_id='{{ site_id }}' --required, 
@snippet_id='{{ snippet_id }}' --required 
@@json=
'{
"general": "{{ general }}", 
"general_position": "{{ general_position }}", 
"goal": "{{ goal }}", 
"goal_position": "{{ goal_position }}", 
"id": {{ id }}, 
"site_id": "{{ site_id }}", 
"title": "{{ title }}"
}'
;