Skip to content

docs.md

Latest commit

 

History

History
165 lines (118 loc) · 4.91 KB

docs.md

File metadata and controls

165 lines (118 loc) · 4.91 KB

sqlite-path Documentation

A full reference to every function and module that sqlite-path offers.

As a reminder, sqlite-path follows semver and is pre v1, so breaking changes are to be expected.

API Reference

path_version()

Returns the semver version string of the current version of sqlite-path.

select path_version();
-- "v0.0.0"

path_debug()

Returns a debug string of various info about sqlite-path, including the version string, build date, commit hash, and cwalk version.

select path_debug();
/*
Version: v0.0.0
Date: 2022-08-19T17:27:14Z-0700
Source: 01cd76716130b739f3e33177740e92e7ad0cff35
cwalk version: v1.2.6
*/

path_absolute(path)

Returns 1 if the given path is absolute, 0 otherwise.

select path_absolute("/usr/local/bin"); -- 1
select path_absolute("./rel/to/me"); -- 0

path_basename(path)

Returns the basename of the given path as text, or NULL if it cannot be calculated.

select path_basename('movies/spiderman.mp4');
-- "spiderman.mp4"

path_dirname(path)

Returns the dirname of the given path as text, or NULL if it cannot be calculated.

select path_dirname('movies/spiderman.mp4');
-- "movies/"

path_extension(path)

Returns the extension of the given path as text, or NULL if it cannot be calculated.

select path_extension('spiderman.mp4'); -- ".mp4"
select path_extension('CHANGELOG'); -- NULL

path_name(path)

Returns the name of the given path as text, or NULL if it cannot be calculated.

select path_name('spiderman.mp4'); -- "spiderman"
select path_name('archive.tar.gz'); -- "archive"
select path_name('CHANGELOG'); -- "CHANGELOG"

path_intersection(path)

Returns the common portions between two paths, or null if it cannot be computed.

SELECT path_intersection('/foo/bar/a', '/foo/bax/a');
-- "/foo"

path_join(path1, path2, [...pathN])

Join two or more paths together, or null if it cannot be computed.

select path_join('src', 'index.js'); -- 'src/index.js'
select path_join('a', 'b', 'c'); -- 'a/b/c'
-- ""

path_normalize(path)

Create a normalized version of the given path (resolving back segments), or null if it cannot be computed. path_relative(path) Returns 1 if the given path is relative, 0 if not, or null if path is null.

select path_normalize('a/x/../b/c');
-- "a/b/c"

path_root(path)

Returns the root portion of the given path, or null if it cannot be computed.

select path_root('/usr/bin'); -- '/'

path_part_at(path, at), path_at(path, at)

Returns the path segment in the given path at the specified index. If 'at' is positive, then '0' is the first segment and counts to the end. If 'at' is negative, then '-1' is the last segment and continue to the beginning. If 'at' "overflows" in either direction, then returns NULL.

select path_at('oppenheimer/projects/manhattan/README', 0); -- 'oppenheimer'
select path_at('oppenheimer/projects/manhattan/README', 1); -- 'projects'
select path_at('oppenheimer/projects/manhattan/README', 2); -- 'manhattan'
select path_at('oppenheimer/projects/manhattan/README', 3); -- 'README'
select path_at('oppenheimer/projects/manhattan/README', 4); -- NULL

select path_at('oppenheimer/projects/manhattan/README', -1); -- 'README'
select path_at('oppenheimer/projects/manhattan/README', -2); -- 'manhattan'
select path_at('oppenheimer/projects/manhattan/README', -5); -- NULL

select * from path_parts(path)

Table function that returns each part of the given path. Return a table with the following schema:

create table path_parts(
 type text,        -- 'normal', 'current', or 'back'
 part text,       -- contents of the current path part
 path text hidden  -- input path
)

rowid can also track the index of the current path.

select rowid, *
from path_parts('oppenheimer/projects/manhattan/./README/..');
/*
┌───────┬─────────┬─────────────┐
│ rowid │  type   │    part     │
├───────┼─────────┼─────────────┤
│ 0     │ normal  │ oppenheimer │
│ 1     │ normal  │ projects    │
│ 2     │ normal  │ manhattan   │
│ 3     │ current │ .           │
│ 4     │ normal  │ README      │
│ 5     │ back    │ ..          │
└───────┴─────────┴─────────────┘
*/