dnscontrol/docs/_functions/domain/PURGE.md
Julius Rickert 6f9e2797b7
DOCS: Fix examples in documentation (#1435)
* Add example include

* Replace example includes

* Remove old example includes
2022-03-04 07:49:03 -05:00

814 B

name
PURGE

PURGE is the default setting for all domains. Therefore PURGE is a no-op. It is included for completeness only.

A domain with a mixture of NO_PURGE and PURGE parameters will abide by the last one.

These three examples all are equivalent.

PURGE is the default:

{% capture example %}

D("example.com", .... ,
);

{% endcapture %}

{% include example.html content=example %}

Purge is the default, but we set it anyway:

{% capture example %}

D("example.com", .... ,
  PURGE,
);

{% endcapture %}

{% include example.html content=example %}

Since the "last command wins", this is the same as PURGE:

{% capture example %}

D("example.com", .... ,
  PURGE,
  NO_PURGE,
  PURGE,
  NO_PURGE,
  PURGE,
);

{% endcapture %}

{% include example.html content=example %}