Skip to content

Update dns-in-google-sheets.mdx to add caching in NSLookup #17298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Oct 24, 2024
Merged

Update dns-in-google-sheets.mdx to add caching in NSLookup #17298

Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
dc32f5c
Update dns-in-google-sheets.mdx to include cache support in the NSLoo…
beltofte Oct 3, 2024
9711bc0
Process suggested changes for Answer TTL and usecache disabled by def…
RebeccaTamachiro Oct 21, 2024
6e8fdcd
Change how minCacheTTL is set
beltofte Oct 21, 2024
06459ce
Minor code style - change tab to spaces.
beltofte Oct 21, 2024
4eb8671
Apply patch + rename usecache to useCache
beltofte Oct 23, 2024
7f6d534
Remove outdated cache value from descriptive paragraph
RebeccaTamachiro Oct 24, 2024
23ab73b
Merge branch 'production' into patch-1
RebeccaTamachiro Oct 24, 2024
8874011
Replace one remaining var by const
RebeccaTamachiro Oct 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 33 additions & 2 deletions src/content/docs/1.1.1.1/other-ways-to-use-1.1.1.1/dns-in-google-sheets.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import { Details } from "~/components"
1.1.1.1 works directly inside Google Sheets. To get started, create a [Google Function](https://developers.google.com/apps-script/guides/sheets/functions) with the following code:

```js
function NSLookup(type, domain) {
function NSLookup(type, domain, usecache = false, cachettl = 1800) {

if (typeof type == 'undefined') {
throw new Error('Missing parameter 1 dns type');
Expand All @@ -22,10 +22,31 @@ function NSLookup(type, domain) {
throw new Error('Missing parameter 2 domain name');
}

if (typeof usecache != "boolean") {
throw new Error('Only boolean values allowed in 3 use cache');
}

if (typeof cachettl != "number") {
throw new Error('Only numeric values allowed in 4 cache ttl');
}

type = type.toUpperCase();
domain = domain.toLowerCase();

if (usecache) {
// Cache key and hash
cacheKey = domain + "@" + type;
cacheHash = Utilities.base64Encode(cacheKey);
cacheBinKey = "nslookup-result-" + cacheHash;

var cache = CacheService.getScriptCache();
var cachedResult = cache.get(cacheBinKey);
if (cachedResult != null) {
return cachedResult;
}
}

var url = 'https://cloudflare-dns.com/dns-query?name=' + encodeURIComponent(domain) + '&type=' + encodeURIComponent(type);

var options = {
muteHttpExceptions: true,
headers: {
Expand Down Expand Up @@ -68,6 +89,15 @@ function NSLookup(type, domain) {

var outputString = outputData.join(',');

if (usecache) {
cache.put(cacheBinKey, outputString, cachettl);
}

for (var i in response.Answer) {
outputData.push(response.Answer[i].data);
minCacheTTL = Math.min(minCacheTTL, response.Answer[i].TTL);
}

return outputString;
}
```
Expand All @@ -76,6 +106,7 @@ function NSLookup(type, domain) {

When you feed the function `NSLookup` a record type and a domain, you will get a DNS record value in the cell you called `NSLookup`.

To limit the number of DNS lookups and speed up the results (especially in larger Google Sheets), you can cache the returned DNS record value for 1800 seconds. Both the cache usage and the cache TTL can be controlled in arguments 3 and 4, respectively.

<Details header="Supported DNS record types">

Expand Down
Loading