Attean...ndpoint(3pm)

πŸ“¦
version 0.002 Β· 3 versions
, in debian bookworm, debian trixie, ubuntu noble, ubuntu questing

πŸ’– AtteanX::Endpoint β€” the whole vibe πŸ’–

okay so bestie, welcome to the AtteanX::Endpoint page πŸŽ€ this lil cutie lives in the User Contributed Perl Documentation section of your friendly neighborhood manual, and it is so ready to spill the tea about SPARQL endpoints. grab a snack, we're doing this ✨


✨ NAME ✨

AtteanX::Endpoint β€” SPARQL 1.1 Protocol Endpoint 🌈

like. it's an endpoint. for the SPARQL 1.1 protocol. that's the whole name, no notes, iconic πŸ’…


🌸 VERSION 🌸

this page is describing AtteanX::Endpoint version 0.002 🫢


πŸ¦‹ SYNOPSIS πŸ¦‹

the way you literally just do this and you're in:

use v5.14;
use Attean;

periodt. that's it. two lines. slay ✨


πŸ’œ DESCRIPTION πŸ’œ

okay so the AtteanX::Endpoint class implements a PSGI SPARQL Protocol endpoint 🧚 no cap, that's the whole deal β€” it's the class that gives you an endpoint, PSGI flavored, speaking SPARQL Protocol. obsessed fr fr 😭


πŸ‘‘ ATTRIBUTES πŸ‘‘

planner

yep. that's the attribute. that's all the doc says about it πŸ’€ it's there, it exists, it's doing its thing, and the docs are respectfully letting it have its privacy πŸ™ˆ

model

same energy bestie β€” this one's listed too, and the page doesn't elaborate. main character energy that says nothing and still gets a spot on the list πŸ‘‘

conf

THIS one has lore πŸ’– it's a hash reference holding configuration data for the endpoint. like, the config lives here. for example:

{
  endpoint  => {
    service_description => {
      named_graphs => 1,
      default => 1,
    },
    html => {
      embed_images => 1,
      image_width => 200,
      resource_links => 1,
    },
    load_data => 0,
    update => 0,
  }
}

look at that structure. look at it. named_graphs and default hanging out under service_description, embed_images, image_width and resource_links doing their thing under html, and load_data + update sitting at the bottom like the chill ones 🌸

graph

this one is the Attean::API::IRI of the graph in the model that represents the default graph ⭐ so like, when someone asks for the default graph, this is the IRI that answers. iykyk ✨


πŸ”₯ METHODS πŸ”₯

run ( $request )

run the SPARQL request contained in the given $request object, and hand back a response object πŸ’« that's the move. request goes in, response comes out, no drama, we love a clean interface 🫢

log_query ( $request, $sparql )

this one logs the $sparql query string β€” and the timing is the cute part: it happens after the query has been parsed out of the $request, but before evaluation πŸ‘€ so you get to see the query in its parsed-and-ready era, pre-evaluation. very "caught in 4k before the plot happens" of it πŸ“Έ

log_error ( $message )

logs an error πŸ’€ it takes a $message, and it logs it. short king of a method, we respect it.


😭 BUGS 😭

found a bug? need a feature? bestie, please report any bugs or feature requests through the GitHub web interface at:

<https://github.com/kasei/atteanx-endpoint/issues>

they want to hear from you, fr fr 🫢


🌈 SEE ALSO 🌈

go look. it's right there. it's giving "Perl RDF community" and it's iconic πŸŽ€


πŸ’– AUTHOR πŸ’–

Gregory Todd Williams β€” "<gwilliams@cpan.org>" πŸ‘‘


Copyright (c) 2016 Gregory Todd Williams. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

so like, free software, same terms as Perl itself, go forth and redistribute responsibly bestie πŸ’…


and that's the page!! this was perl v5.36.0, dated 2022-12-06, and yeah β€” it's the Attean...ndpoint(3pm) page, we been knew 🌸 mwah, go build an endpoint, you got this 🫢✨

πŸ“¦ where this page comes from