Runtime and Storage Starter Pack

'use strict';

// Estimate the number of fragments in the wild-llamas collection.
// xdmp:estimate()'s JS equivalent is cts.estimate() - xdmp.estimate is not exposed to JavaScript.
const estimate = cts.estimate(cts.collectionQuery('wild-llamas'));

const results = {
  collectionEstimate: estimate,
  collectionName: 'wild-llamas',
  message: `Estimated size of wild-llamas collection: ${estimate} fragments`
};

({
  sample: 'xdmp/runtime-storage-starter-pack/assets/xdmp-estimate.sjs',
  kind: Array.isArray(results) ? (results.every((item) => typeof item === 'object' && 'subject' in item && 'predicate' in item && 'object' in item) ? 'triples' : 'rows') : ((results !== null && typeof results === 'object') ? 'object' : 'scalar'),
  count: Array.isArray(results) ? results.length : 0,
  data: results
});

'use strict';

// Find a document from wild-llamas and check its forest placement.
const sampleUri = cts.uris(null, null, cts.collectionQuery('wild-llamas')).toArray()[0];

if (!sampleUri) {
  throw new Error('NO-LLAMAVERSE: No documents found in collection wild-llamas.');
}

const forestId = xdmp.documentForest(sampleUri);
const forestName = xdmp.forestName(forestId);

const results = {
  documentUri: sampleUri,
  forestId: forestId,
  forestName: forestName,
  collection: 'wild-llamas'
};

({
  sample: 'xdmp/runtime-storage-starter-pack/assets/xdmp-document-forest.sjs',
  kind: Array.isArray(results) ? (results.every((item) => typeof item === 'object' && 'subject' in item && 'predicate' in item && 'object' in item) ? 'triples' : 'rows') : ((results !== null && typeof results === 'object') ? 'object' : 'scalar'),
  count: Array.isArray(results) ? results.length : 0,
  data: results
});

'use strict';

// Find a document from wild-llamas and check its format.
const sampleUri = cts.uris(null, null, cts.collectionQuery('wild-llamas')).toArray()[0];

if (!sampleUri) {
  throw new Error('NO-LLAMAVERSE: No documents found in collection wild-llamas.');
}

const format = xdmp.uriFormat(sampleUri);

const results = {
  documentUri: sampleUri,
  format: format,
  collection: 'wild-llamas',
  message: `Document at ${sampleUri} is in ${format} format`
};

({
  sample: 'xdmp/runtime-storage-starter-pack/assets/xdmp-uri-format.sjs',
  kind: Array.isArray(results) ? (results.every((item) => typeof item === 'object' && 'subject' in item && 'predicate' in item && 'object' in item) ? 'triples' : 'rows') : ((results !== null && typeof results === 'object') ? 'object' : 'scalar'),
  count: Array.isArray(results) ? results.length : 0,
  data: results
});

'use strict';

// Which database is Katrina's profile photo actually stored in?
const photoUri = '/cleverllamas/llamaverse/content/llamas/images/1024fa02-cd67-44f2-8d8c-0c5f16ccb7d1.gif';
const photo = fn.head(cts.doc(photoUri));

if (!photo) {
  throw new Error('NO-LLAMAVERSE: Katrina\'s profile photo was not found. Deploy llamaverse 2.6.0 or later.');
}

const databaseId = xdmp.nodeDatabase(photo);

const results = {
  photoUri: photoUri,
  databaseId: databaseId,
  databaseName: xdmp.databaseName(databaseId)
};

({
  sample: 'xdmp/runtime-storage-starter-pack/assets/xdmp-node-database.sjs',
  kind: Array.isArray(results) ? (results.every((item) => typeof item === 'object' && 'subject' in item && 'predicate' in item && 'object' in item) ? 'triples' : 'rows') : ((results !== null && typeof results === 'object') ? 'object' : 'scalar'),
  count: Array.isArray(results) ? results.length : 0,
  data: results
});

'use strict';

// Same content type, two different storage models: compare Katrina (regular) and Aaron (registered/external).
function binaryNode(uri) {
  const doc = fn.head(cts.doc(uri));
  return doc ? fn.head(doc.xpath('node()')) : null;
}

const katrinaUri = '/cleverllamas/llamaverse/content/llamas/images/1024fa02-cd67-44f2-8d8c-0c5f16ccb7d1.gif';
const aaronUri = '/cleverllamas/llamaverse/content/llamas/images/0c8bdb0d-ac62-49b7-ac74-94dbba46efa5.gif';
const katrina = binaryNode(katrinaUri);
const aaron = binaryNode(aaronUri);

if (!katrina || !aaron) {
  throw new Error('NO-LLAMAVERSE: Katrina\'s or Aaron\'s profile photo was not found. Deploy llamaverse 2.6.0 or later and register Aaron\'s external binary.');
}

const results = {
  katrina: { uri: katrinaUri, isExternal: xdmp.binaryIsExternal(katrina) },
  aaron: { uri: aaronUri, isExternal: xdmp.binaryIsExternal(aaron) }
};

({
  sample: 'xdmp/runtime-storage-starter-pack/assets/xdmp-binary-is-external.sjs',
  kind: Array.isArray(results) ? (results.every((item) => typeof item === 'object' && 'subject' in item && 'predicate' in item && 'object' in item) ? 'triples' : 'rows') : ((results !== null && typeof results === 'object') ? 'object' : 'scalar'),
  count: Array.isArray(results) ? results.length : 0,
  data: results
});

'use strict';

// Binary size in bytes is the same kind of number regardless of storage model.
function binaryNode(uri) {
  const doc = fn.head(cts.doc(uri));
  return doc ? fn.head(doc.xpath('node()')) : null;
}

const katrinaUri = '/cleverllamas/llamaverse/content/llamas/images/1024fa02-cd67-44f2-8d8c-0c5f16ccb7d1.gif';
const aaronUri = '/cleverllamas/llamaverse/content/llamas/images/0c8bdb0d-ac62-49b7-ac74-94dbba46efa5.gif';
const katrina = binaryNode(katrinaUri);
const aaron = binaryNode(aaronUri);

if (!katrina || !aaron) {
  throw new Error('NO-LLAMAVERSE: Katrina\'s or Aaron\'s profile photo was not found. Deploy llamaverse 2.6.0 or later and register Aaron\'s external binary.');
}

const results = {
  katrina: { uri: katrinaUri, sizeBytes: xdmp.binarySize(katrina) },
  aaron: { uri: aaronUri, sizeBytes: xdmp.binarySize(aaron) }
};

({
  sample: 'xdmp/runtime-storage-starter-pack/assets/xdmp-binary-size.sjs',
  kind: Array.isArray(results) ? (results.every((item) => typeof item === 'object' && 'subject' in item && 'predicate' in item && 'object' in item) ? 'triples' : 'rows') : ((results !== null && typeof results === 'object') ? 'object' : 'scalar'),
  count: Array.isArray(results) ? results.length : 0,
  data: results
});

'use strict';

// A binary can be neither large nor small - both flags describe internal storage tiering.
function binaryNode(uri) {
  const doc = fn.head(cts.doc(uri));
  return doc ? fn.head(doc.xpath('node()')) : null;
}

const katrinaUri = '/cleverllamas/llamaverse/content/llamas/images/1024fa02-cd67-44f2-8d8c-0c5f16ccb7d1.gif';
const aaronUri = '/cleverllamas/llamaverse/content/llamas/images/0c8bdb0d-ac62-49b7-ac74-94dbba46efa5.gif';
const katrina = binaryNode(katrinaUri);
const aaron = binaryNode(aaronUri);

if (!katrina || !aaron) {
  throw new Error('NO-LLAMAVERSE: Katrina\'s or Aaron\'s profile photo was not found. Deploy llamaverse 2.6.0 or later and register Aaron\'s external binary.');
}

const results = {
  katrina: { uri: katrinaUri, sizeBytes: xdmp.binarySize(katrina), isLarge: xdmp.binaryIsLarge(katrina), isSmall: xdmp.binaryIsSmall(katrina) },
  aaron: { uri: aaronUri, sizeBytes: xdmp.binarySize(aaron), isLarge: xdmp.binaryIsLarge(aaron), isSmall: xdmp.binaryIsSmall(aaron) }
};

({
  sample: 'xdmp/runtime-storage-starter-pack/assets/xdmp-binary-is-large-and-small.sjs',
  kind: Array.isArray(results) ? (results.every((item) => typeof item === 'object' && 'subject' in item && 'predicate' in item && 'object' in item) ? 'triples' : 'rows') : ((results !== null && typeof results === 'object') ? 'object' : 'scalar'),
  count: Array.isArray(results) ? results.length : 0,
  data: results
});

'use strict';

// xdmp.externalBinaryPath() quietly returns an empty sequence for a regular binary instead of raising an error.
function binaryNode(uri) {
  const doc = fn.head(cts.doc(uri));
  return doc ? fn.head(doc.xpath('node()')) : null;
}

const katrinaUri = '/cleverllamas/llamaverse/content/llamas/images/1024fa02-cd67-44f2-8d8c-0c5f16ccb7d1.gif';
const aaronUri = '/cleverllamas/llamaverse/content/llamas/images/0c8bdb0d-ac62-49b7-ac74-94dbba46efa5.gif';
const katrina = binaryNode(katrinaUri);
const aaron = binaryNode(aaronUri);

if (!katrina || !aaron) {
  throw new Error('NO-LLAMAVERSE: Katrina\'s or Aaron\'s profile photo was not found. Deploy llamaverse 2.6.0 or later and register Aaron\'s external binary.');
}

const aaronPath = fn.head(xdmp.externalBinaryPath(aaron));
const katrinaPath = fn.head(xdmp.externalBinaryPath(katrina));

const results = {
  aaron: { uri: aaronUri, externalBinaryPath: aaronPath !== null ? aaronPath : '(no path returned)' },
  katrina: { uri: katrinaUri, externalBinaryPath: katrinaPath !== null ? katrinaPath : '(empty sequence - not a registered binary)' }
};

({
  sample: 'xdmp/runtime-storage-starter-pack/assets/xdmp-external-binary-path.sjs',
  kind: Array.isArray(results) ? (results.every((item) => typeof item === 'object' && 'subject' in item && 'predicate' in item && 'object' in item) ? 'triples' : 'rows') : ((results !== null && typeof results === 'object') ? 'object' : 'scalar'),
  count: Array.isArray(results) ? results.length : 0,
  data: results
});

'use strict';

// The check happens on the MarkLogic host's filesystem, not the client's.
function binaryNode(uri) {
  const doc = fn.head(cts.doc(uri));
  return doc ? fn.head(doc.xpath('node()')) : null;
}

const aaronUri = '/cleverllamas/llamaverse/content/llamas/images/0c8bdb0d-ac62-49b7-ac74-94dbba46efa5.gif';
const aaron = binaryNode(aaronUri);

if (!aaron) {
  throw new Error('NO-LLAMAVERSE: Aaron\'s profile photo was not found. Deploy llamaverse 2.6.0 or later and register Aaron\'s external binary.');
}

const realPath = xdmp.externalBinaryPath(aaron);
const madeUpPath = '/var/opt/MarkLogic/external-binaries/llamas/does-not-exist.gif';

const results = {
  realPath: { path: realPath, exists: xdmp.filesystemFileExists(realPath) },
  madeUpPath: { path: madeUpPath, exists: xdmp.filesystemFileExists(madeUpPath) }
};

({
  sample: 'xdmp/runtime-storage-starter-pack/assets/xdmp-filesystem-file-exists.sjs',
  kind: Array.isArray(results) ? (results.every((item) => typeof item === 'object' && 'subject' in item && 'predicate' in item && 'object' in item) ? 'triples' : 'rows') : ((results !== null && typeof results === 'object') ? 'object' : 'scalar'),
  count: Array.isArray(results) ? results.length : 0,
  data: results
});